Skip to content

Preserve Markdown frontmatter and check documentation sources #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timkpaine merged 1 commit into from
Oct 6, 2026
Merged

Preserve Markdown frontmatter and check documentation sources #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions python/cpp/Makefile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ lint-cpp: ## run cpp linter
clang-format --dry-run -Werror -i -style=file `find ./cpp -name "*.*pp"`

lint-docs: ## lint docs with mdformat and codespell
python -m mdformat --check README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat --check README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

lint: lint-cpp lint-py ## run project linters

Expand All @@ -47,8 +47,8 @@ fix-cpp: ## fix cpp formatting
clang-format -i -style=file `find ./cpp -name "*.*pp"`

fix-docs: ## autoformat docs with mdformat and codespell
python -m mdformat README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

fix: fix-cpp fix-py fix-docs ## run project autoformatters

Expand Down
1 change: 1 addition & 0 deletions python/cpp/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ develop = [
"hatch-cpp{% if add_pyodide %}>=0.5.0{% endif %}",
"hatchling",
"mdformat",
"mdformat-frontmatter",
"mdformat-tables>=1",
"pybind11",
"pytest",
Expand Down
8 changes: 4 additions & 4 deletions python/cppjswasm/Makefile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ lint-cpp: ## run C++ linter
make -C cpp lint

lint-docs: ## lint docs with mdformat and codespell
python -m mdformat --check README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat --check README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

lint: lint-cpp lint-js lint-py lint-docs ## run project linters

Expand All @@ -78,8 +78,8 @@ fix-cpp: ## fix C++ formatting
make -C cpp fix

fix-docs: ## autoformat docs with mdformat and codespell
python -m mdformat README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

fix: fix-cpp fix-js fix-py fix-docs ## run project autoformatters

Expand Down
1 change: 1 addition & 0 deletions python/cppjswasm/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ develop = [
"hatchling",
"pybind11",
"mdformat",
"mdformat-frontmatter",
"mdformat-tables>=1",
"pytest",
"pytest-cov",
Expand Down
8 changes: 4 additions & 4 deletions python/cython/Makefile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ lint-py: ## lint Python with ruff
python -m ruff format --check {{ module }}

lint-docs: ## lint documentation
python -m mdformat --check README.md docs/development.md{% if add_wiki %} docs/wiki/{% endif %}
python -m codespell_lib README.md docs/development.md{% if add_wiki %} docs/wiki/{% endif %}
python -m mdformat --check README.md docs/development.md $(wildcard docs/src){% if add_wiki %} docs/wiki/{% endif %}
python -m codespell_lib README.md docs/development.md $(wildcard docs/src){% if add_wiki %} docs/wiki/{% endif %}

fix-py: ## autoformat Python code
python -m ruff check --fix {{ module }}
python -m ruff format {{ module }}

fix-docs: ## autoformat documentation
python -m mdformat README.md docs/development.md{% if add_wiki %} docs/wiki/{% endif %}
python -m codespell_lib --write README.md docs/development.md{% if add_wiki %} docs/wiki/{% endif %}
python -m mdformat README.md docs/development.md $(wildcard docs/src){% if add_wiki %} docs/wiki/{% endif %}
python -m codespell_lib --write README.md docs/development.md $(wildcard docs/src){% if add_wiki %} docs/wiki/{% endif %}

lint: lint-py lint-docs ## run all linters
lints: lint
Expand Down
1 change: 1 addition & 0 deletions python/cython/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ develop = [
"hatch-cython",
"hatchling",
"mdformat",
"mdformat-frontmatter",
"mdformat-tables>=1",
"pytest",
"pytest-cov",
Expand Down
8 changes: 4 additions & 4 deletions python/js/Makefile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ lint-js: ## run js linter
cd js; pnpm lint

lint-docs: ## lint docs with mdformat and codespell
python -m mdformat --check README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat --check README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

lint: lint-js lint-py lint-docs ## run project linters

Expand All @@ -60,8 +60,8 @@ fix-js: ## fix js formatting
cd js; pnpm fix

fix-docs: ## autoformat docs with mdformat and codespell
python -m mdformat README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

fix: fix-js fix-py fix-docs ## run project autoformatters

Expand Down
1 change: 1 addition & 0 deletions python/js/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ develop = [
"hatch-js",
"hatchling",
"mdformat",
"mdformat-frontmatter",
"mdformat-tables>=1",
"pytest",
"pytest-cov",
Expand Down
8 changes: 4 additions & 4 deletions python/jupyter/Makefile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ lint-js: ## run js linter
cd js; pnpm lint

lint-docs: ## lint docs with mdformat and codespell
python -m mdformat --check README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat --check README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

lint: lint-js lint-py lint-docs ## run project linters

Expand All @@ -62,8 +62,8 @@ fix-js: ## fix js formatting
cd js; pnpm fix

fix-docs: ## autoformat docs with mdformat and codespell
python -m mdformat README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

fix: fix-js fix-py fix-docs ## run project autoformatters

Expand Down
1 change: 1 addition & 0 deletions python/jupyter/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ develop = [
"hatchling",
"jupyter-builder>=1.2.3,<2",
"mdformat",
"mdformat-frontmatter",
"mdformat-tables>=1",
"jupyterlab>=4,<5",
"pytest",
Expand Down
8 changes: 4 additions & 4 deletions python/pure/Makefile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ lint-py: ## lint python with ruff
python -m ruff format --check {{ module }}

lint-docs: ## lint docs with mdformat and codespell
python -m mdformat --check README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat --check README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

fix-py: ## autoformat python code with ruff
python -m ruff check --fix {{ module }}
python -m ruff format {{ module }}

fix-docs: ## autoformat docs with mdformat and codespell
python -m mdformat README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

lint: lint-py lint-docs ## run all linters
lints: lint
Expand Down
1 change: 1 addition & 0 deletions python/pure/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ develop = [
"codespell",
"hatchling",
"mdformat",
"mdformat-frontmatter",
"mdformat-tables>=1",
"pytest",
"pytest-cov",
Expand Down
8 changes: 4 additions & 4 deletions python/rust/Makefile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ lint-rs: ## run rust linter
make -C rust lint

lint-docs: ## lint docs with mdformat and codespell
python -m mdformat --check README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat --check README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

lint: lint-rs lint-py lint-docs ## run project linters

Expand All @@ -61,8 +61,8 @@ fix-rs: ## fix rust formatting
make -C rust fix

fix-docs: ## autoformat docs with mdformat and codespell
python -m mdformat README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

fix: fix-rs fix-py fix-docs ## run project autoformatters

Expand Down
1 change: 1 addition & 0 deletions python/rust/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ develop = [
"hatch-rs{% if add_pyodide %}>=0.3.0{% endif %}",
"hatchling",
"mdformat",
"mdformat-frontmatter",
"mdformat-tables>=1",
"pytest",
"pytest-cov",
Expand Down
8 changes: 4 additions & 4 deletions python/rustjswasm/Makefile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ lint-rs: ## run rust linter
make -C rust lint

lint-docs: ## lint docs with mdformat and codespell
python -m mdformat --check README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat --check README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

lint: lint-rs lint-js lint-py lint-docs ## run project linters

Expand All @@ -75,8 +75,8 @@ fix-rs: ## fix rust formatting
make -C rust fix

fix-docs: ## autoformat docs with mdformat and codespell
python -m mdformat README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md {% if add_wiki %}docs/wiki/{% endif %}
python -m mdformat README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}
python -m codespell_lib --write README.md $(wildcard docs/src) {% if add_wiki %}docs/wiki/{% endif %}

fix: fix-rs fix-js fix-py fix-docs ## run project autoformatters

Expand Down
1 change: 1 addition & 0 deletions python/rustjswasm/pyproject.toml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ develop = [
"hatch-rs{% if add_pyodide %}>=0.3.0{% endif %}",
"hatchling",
"mdformat",
"mdformat-frontmatter",
"mdformat-tables>=1",
"pytest",
"pytest-cov",
Expand Down
Loading