From acb48747d68adece7fe123636ed474f6cb6cb5cc Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Tue, 23 Jun 2026 10:51:56 -0400 Subject: [PATCH] fix(docs): move pages out of pages/ to restore original URLs The mystmd conversion nested every page under `pages/`, which added a `pages/` segment to all guide URLs (e.g. `/development/guides/mypy/` became `/development/pages/guides/mypy/`), breaking existing links into the development guide. Move the page tree back up one level so the URLs match the pre-mystmd paths and old links work again: - `git mv docs/pages/{guides,tutorials,principles,patterns,index.md}` to `docs/` - strip `pages/` from the toc in myst.yml and from internal cross-reference links - adjust the real `{include}` directives for `_partials/pyproject.md` (one less directory level) - update `docs/pages/` path references in noxfile.py and .pre-commit-config.yaml Assisted-by: ClaudeCode:claude-opus-4.8 --- .pre-commit-config.yaml | 4 +- docs/README.md | 3 +- docs/{pages => }/guides/coverage.md | 0 docs/{pages => }/guides/docs.md | 0 docs/{pages => }/guides/gha_basic.md | 0 docs/{pages => }/guides/gha_pure.md | 2 +- docs/{pages => }/guides/gha_wheels.md | 0 docs/{pages => }/guides/index.md | 26 ++++----- docs/{pages => }/guides/mypy.md | 2 +- docs/{pages => }/guides/packaging_classic.md | 2 +- docs/{pages => }/guides/packaging_compiled.md | 6 +- docs/{pages => }/guides/packaging_simple.md | 2 +- docs/{pages => }/guides/pytest.md | 0 docs/{pages => }/guides/repo_review.md | 0 docs/{pages => }/guides/style.md | 2 +- docs/{pages => }/guides/tasks.md | 0 docs/{pages => }/index.md | 24 ++++---- docs/myst.yml | 58 +++++++++---------- docs/{pages => }/patterns/backports.md | 0 docs/{pages => }/patterns/data_files.md | 0 docs/{pages => }/patterns/exports.md | 0 docs/{pages => }/patterns/index.md | 6 +- docs/{pages => }/principles/design.md | 0 docs/{pages => }/principles/index.md | 4 +- docs/{pages => }/principles/process.md | 0 docs/{pages => }/principles/testing.md | 6 +- docs/{pages => }/tutorials/dev-environment.md | 0 docs/{pages => }/tutorials/docs.md | 4 +- docs/{pages => }/tutorials/index.md | 4 +- docs/{pages => }/tutorials/module.md | 2 +- docs/{pages => }/tutorials/packaging.md | 2 +- docs/{pages => }/tutorials/test.md | 2 +- noxfile.py | 10 ++-- 33 files changed, 86 insertions(+), 85 deletions(-) rename docs/{pages => }/guides/coverage.md (100%) rename docs/{pages => }/guides/docs.md (100%) rename docs/{pages => }/guides/gha_basic.md (100%) rename docs/{pages => }/guides/gha_pure.md (99%) rename docs/{pages => }/guides/gha_wheels.md (100%) rename docs/{pages => }/guides/index.md (78%) rename docs/{pages => }/guides/mypy.md (99%) rename docs/{pages => }/guides/packaging_classic.md (99%) rename docs/{pages => }/guides/packaging_compiled.md (98%) rename docs/{pages => }/guides/packaging_simple.md (99%) rename docs/{pages => }/guides/pytest.md (100%) rename docs/{pages => }/guides/repo_review.md (100%) rename docs/{pages => }/guides/style.md (99%) rename docs/{pages => }/guides/tasks.md (100%) rename docs/{pages => }/index.md (85%) rename docs/{pages => }/patterns/backports.md (100%) rename docs/{pages => }/patterns/data_files.md (100%) rename docs/{pages => }/patterns/exports.md (100%) rename docs/{pages => }/patterns/index.md (78%) rename docs/{pages => }/principles/design.md (100%) rename docs/{pages => }/principles/index.md (74%) rename docs/{pages => }/principles/process.md (100%) rename docs/{pages => }/principles/testing.md (99%) rename docs/{pages => }/tutorials/dev-environment.md (100%) rename docs/{pages => }/tutorials/docs.md (97%) rename docs/{pages => }/tutorials/index.md (87%) rename docs/{pages => }/tutorials/module.md (98%) rename docs/{pages => }/tutorials/packaging.md (98%) rename docs/{pages => }/tutorials/test.md (99%) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f2df43f5..67718f29 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -87,7 +87,7 @@ repos: name: Disallow improper capitalization language: pygrep entry: PyBind|Numpy|Cmake|CCache|Github|PyTest|RST|PyLint - exclude: (.pre-commit-config.yaml|docs/pages/guides/style\.md)$ + exclude: (.pre-commit-config.yaml|docs/guides/style\.md)$ - id: disallow-words name: Disallow certain words language: pygrep @@ -101,5 +101,5 @@ repos: name: Cog the pages language: python entry: cog -P -r -I ./helpers - files: "^docs/pages/guides/(packaging_compiled|docs|tasks|gha_basic).md|^copier.yml|^docs/_partials/pyproject.md" + files: "^docs/guides/(packaging_compiled|docs|tasks|gha_basic).md|^copier.yml|^docs/_partials/pyproject.md" additional_dependencies: [cogapp, cookiecutter, tomlkit] diff --git a/docs/README.md b/docs/README.md index a191a7bd..798ac014 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,7 +19,8 @@ bundle install bundle exec jekyll serve --livereload ``` -The pages are in markdown in `pages/`. Images and data files are in `assets/`. +The pages are in markdown, in the `guides/`, `tutorials/`, `principles/`, and +`patterns/` folders. Images and data files are in `assets/`. To bump versions, use nox. You can run `nox -s pc_bump` to bump the pre-commit versions, and `nox -s gha_bump` to bump the GitHub Actions versions. diff --git a/docs/pages/guides/coverage.md b/docs/guides/coverage.md similarity index 100% rename from docs/pages/guides/coverage.md rename to docs/guides/coverage.md diff --git a/docs/pages/guides/docs.md b/docs/guides/docs.md similarity index 100% rename from docs/pages/guides/docs.md rename to docs/guides/docs.md diff --git a/docs/pages/guides/gha_basic.md b/docs/guides/gha_basic.md similarity index 100% rename from docs/pages/guides/gha_basic.md rename to docs/guides/gha_basic.md diff --git a/docs/pages/guides/gha_pure.md b/docs/guides/gha_pure.md similarity index 99% rename from docs/pages/guides/gha_pure.md rename to docs/guides/gha_pure.md index 50fd495a..230b162b 100644 --- a/docs/pages/guides/gha_pure.md +++ b/docs/guides/gha_pure.md @@ -26,7 +26,7 @@ reasons that a wheel is better than only providing an sdist: is going to go ::: -[on the next page]: pages/guides/gha-wheels +[on the next page]: guides/gha-wheels ## Job setup diff --git a/docs/pages/guides/gha_wheels.md b/docs/guides/gha_wheels.md similarity index 100% rename from docs/pages/guides/gha_wheels.md rename to docs/guides/gha_wheels.md diff --git a/docs/pages/guides/index.md b/docs/guides/index.md similarity index 78% rename from docs/pages/guides/index.md rename to docs/guides/index.md index 96b733ef..c3ecc900 100644 --- a/docs/pages/guides/index.md +++ b/docs/guides/index.md @@ -34,19 +34,19 @@ your repository with the guidelines, runnable [right in the guide][] via WebAssembly! All checks point to a linked badge in the guide. ::: -[tutorials]: pages/tutorials/index -[style]: pages/guides/style -[mypy]: pages/guides/mypy -[docs]: pages/guides/docs -[simple packaging]: pages/guides/packaging-simple -[compiled packaging]: pages/guides/packaging-compiled -[classic packaging]: pages/guides/packaging-classic -[coverage]: pages/guides/coverage -[gha_basic]: pages/guides/gha-basic -[gha_pure]: pages/guides/gha-pure -[gha_wheels]: pages/guides/gha-wheels -[pytest]: pages/guides/pytest -[right in the guide]: pages/guides/repo-review +[tutorials]: tutorials/index +[style]: guides/style +[mypy]: guides/mypy +[docs]: guides/docs +[simple packaging]: guides/packaging-simple +[compiled packaging]: guides/packaging-compiled +[classic packaging]: guides/packaging-classic +[coverage]: guides/coverage +[gha_basic]: guides/gha-basic +[gha_pure]: guides/gha-pure +[gha_wheels]: guides/gha-wheels +[pytest]: guides/pytest +[right in the guide]: guides/repo-review [cookiecutter]: https://cookiecutter.readthedocs.io [copier]: https://copier.readthedocs.io diff --git a/docs/pages/guides/mypy.md b/docs/guides/mypy.md similarity index 99% rename from docs/pages/guides/mypy.md rename to docs/guides/mypy.md index 0a4466db..2a311874 100644 --- a/docs/pages/guides/mypy.md +++ b/docs/guides/mypy.md @@ -70,7 +70,7 @@ everything. Try to turn on as much as possible, and increase it until you can run with full `strict` checking. See the [style page][] for configuration suggestions. -[style page]: pages/guides/style +[style page]: guides/style For a library to support typing, it has to a) add types using any of the three methods, and b) add a `py.typed` empty file to indicate that it's okay to look diff --git a/docs/pages/guides/packaging_classic.md b/docs/guides/packaging_classic.md similarity index 99% rename from docs/pages/guides/packaging_classic.md rename to docs/guides/packaging_classic.md index 84a601bb..79813990 100644 --- a/docs/pages/guides/packaging_classic.md +++ b/docs/guides/packaging_classic.md @@ -8,7 +8,7 @@ outlined as well. There are several popular packaging systems. This guide covers the old configuration style for [Setuptools][]. Unless you really need it, you should be using the modern style described in [Simple -Packaging](pages/guides/packaging-simple). The modern style is +Packaging](guides/packaging-simple). The modern style is guided by Python Enhancement Proposals (PEPs), and is more stable than the setuptools-specific mechanisms that evolve over the years. This page is kept to help users with legacy code (and hopefully upgrade it). diff --git a/docs/pages/guides/packaging_compiled.md b/docs/guides/packaging_compiled.md similarity index 98% rename from docs/pages/guides/packaging_compiled.md rename to docs/guides/packaging_compiled.md index c72dc2cc..c33deae2 100644 --- a/docs/pages/guides/packaging_compiled.md +++ b/docs/guides/packaging_compiled.md @@ -40,7 +40,7 @@ The most exciting developments have been new native build backends: :::{note} You should be familiar with [packing a pure Python -project](pages/guides/packaging-simple) - the metadata +project](guides/packaging-simple) - the metadata configuration is the same. ::: There are also classic setuptools plugins: @@ -112,7 +112,7 @@ build-backend = "maturin" ::: :::: -```{include} ../../_partials/pyproject.md +```{include} ../_partials/pyproject.md ``` ## Tool section in pyproject.toml @@ -453,4 +453,4 @@ it is free-threaded. 3.13.5 was rushed out to fix it. [meson-python]: https://meson-python.readthedocs.io [setuptools-rust]: https://setuptools-rust.readthedocs.io/en/latest/ [maturin]: https://www.maturin.rs -[gha_wheels]: pages/guides/gha-wheels +[gha_wheels]: guides/gha-wheels diff --git a/docs/pages/guides/packaging_simple.md b/docs/guides/packaging_simple.md similarity index 99% rename from docs/pages/guides/packaging_simple.md rename to docs/guides/packaging_simple.md index 6b8cc7d9..87439072 100644 --- a/docs/pages/guides/packaging_simple.md +++ b/docs/guides/packaging_simple.md @@ -86,7 +86,7 @@ build-backend = "setuptools.build_meta" ::: :::: -```{include} ../../_partials/pyproject.md +```{include} ../_partials/pyproject.md ``` For `requires-python`, you should specify the minimum you require, and you diff --git a/docs/pages/guides/pytest.md b/docs/guides/pytest.md similarity index 100% rename from docs/pages/guides/pytest.md rename to docs/guides/pytest.md diff --git a/docs/pages/guides/repo_review.md b/docs/guides/repo_review.md similarity index 100% rename from docs/pages/guides/repo_review.md rename to docs/guides/repo_review.md diff --git a/docs/pages/guides/style.md b/docs/guides/style.md similarity index 99% rename from docs/pages/guides/style.md rename to docs/guides/style.md index 730d2f57..a1a8f69e 100644 --- a/docs/pages/guides/style.md +++ b/docs/guides/style.md @@ -674,7 +674,7 @@ and `ignore-without-code` {rr}`MY104`, `redundant-expr` {rr}`MY105`, and checks) and have to be ignored occasionally, but can find some significant logic errors in your typing. -[mypy page]: pages/guides/mypy +[mypy page]: guides/mypy ## Setuptools specific checks diff --git a/docs/pages/guides/tasks.md b/docs/guides/tasks.md similarity index 100% rename from docs/pages/guides/tasks.md rename to docs/guides/tasks.md diff --git a/docs/pages/index.md b/docs/index.md similarity index 85% rename from docs/pages/index.md rename to docs/index.md index f56ce744..0e01eb3d 100644 --- a/docs/pages/index.md +++ b/docs/index.md @@ -13,10 +13,10 @@ fellow scientists and research software engineers. Jupyter notebooks that are becoming unwieldy? Are changes to some parts of your code accidentally breaking other parts of your code? Do you want to present them in a more maintainable, reusable, and shareable form? Start at the -[tutorial](pages/tutorials/index). +[tutorial](tutorials/index). **Learn recommended tools and best practices.** -[Topical guides](pages/guides/index) provide task-based instruction on topics +[Topical guides](guides/index) provide task-based instruction on topics that scientists and research software engineers may encounter as their projects evolve and grow. This covers modern packaging ([simple][] or [compiled][]), [style checking][], [testing][], [documentation][], [static typing][], [CI][], @@ -35,12 +35,12 @@ WebAssembly! All checks point to a linked badge in the guide. ::: **Learn to write better research code.** A high-level document on -[principles](pages/principles/index) provides advice based on the +[principles](principles/index) provides advice based on the community's collective experience building code that is easier for researchers to use successfully and easier to maintain over time. **Use our solutions for common tasks.** A growing collection of -[patterns](pages/patterns/index) provides tested approaches for +[patterns](patterns/index) provides tested approaches for tasks and can be tricky to get exactly right, such as including data files with Python packages. @@ -75,14 +75,14 @@ with many updates. Improved support for compiled components supported in part by NSF grant [OAC-2209877][]. ::: -[simple]: pages/guides/packaging-simple -[compiled]: pages/guides/packaging-compiled -[style checking]: pages/guides/style -[testing]: pages/guides/pytest -[documentation]: pages/guides/docs -[static typing]: pages/guides/mypy -[ci]: pages/guides/gha-pure -[right in the guide]: pages/guides/repo-review +[simple]: guides/packaging-simple +[compiled]: guides/packaging-compiled +[style checking]: guides/style +[testing]: guides/pytest +[documentation]: guides/docs +[static typing]: guides/mypy +[ci]: guides/gha-pure +[right in the guide]: guides/repo-review [scientific-python/cookie]: https://github.com/scientific-python/cookie [repo-review]: https://repo-review.readthedocs.io diff --git a/docs/myst.yml b/docs/myst.yml index 4239b346..0a470973 100644 --- a/docs/myst.yml +++ b/docs/myst.yml @@ -9,39 +9,39 @@ project: - rr-role.mjs toc: - - file: pages/index.md - - file: pages/tutorials/index.md + - file: index.md + - file: tutorials/index.md children: - - file: pages/tutorials/dev-environment.md - - file: pages/tutorials/module.md - - file: pages/tutorials/packaging.md - - file: pages/tutorials/test.md - - file: pages/tutorials/docs.md - - file: pages/guides/index.md + - file: tutorials/dev-environment.md + - file: tutorials/module.md + - file: tutorials/packaging.md + - file: tutorials/test.md + - file: tutorials/docs.md + - file: guides/index.md children: - - file: pages/guides/pytest.md - - file: pages/guides/coverage.md - - file: pages/guides/docs.md - - file: pages/guides/packaging_simple.md - - file: pages/guides/packaging_compiled.md - - file: pages/guides/packaging_classic.md - - file: pages/guides/style.md - - file: pages/guides/mypy.md - - file: pages/guides/gha_basic.md - - file: pages/guides/gha_pure.md - - file: pages/guides/gha_wheels.md - - file: pages/guides/tasks.md - - file: pages/principles/index.md + - file: guides/pytest.md + - file: guides/coverage.md + - file: guides/docs.md + - file: guides/packaging_simple.md + - file: guides/packaging_compiled.md + - file: guides/packaging_classic.md + - file: guides/style.md + - file: guides/mypy.md + - file: guides/gha_basic.md + - file: guides/gha_pure.md + - file: guides/gha_wheels.md + - file: guides/tasks.md + - file: principles/index.md children: - - file: pages/principles/process.md - - file: pages/principles/design.md - - file: pages/principles/testing.md - - file: pages/patterns/index.md + - file: principles/process.md + - file: principles/design.md + - file: principles/testing.md + - file: patterns/index.md children: - - file: pages/patterns/exports.md - - file: pages/patterns/backports.md - - file: pages/patterns/data_files.md - - file: pages/guides/repo_review.md + - file: patterns/exports.md + - file: patterns/backports.md + - file: patterns/data_files.md + - file: guides/repo_review.md site: template: book-theme diff --git a/docs/pages/patterns/backports.md b/docs/patterns/backports.md similarity index 100% rename from docs/pages/patterns/backports.md rename to docs/patterns/backports.md diff --git a/docs/pages/patterns/data_files.md b/docs/patterns/data_files.md similarity index 100% rename from docs/pages/patterns/data_files.md rename to docs/patterns/data_files.md diff --git a/docs/pages/patterns/exports.md b/docs/patterns/exports.md similarity index 100% rename from docs/pages/patterns/exports.md rename to docs/patterns/exports.md diff --git a/docs/pages/patterns/index.md b/docs/patterns/index.md similarity index 78% rename from docs/pages/patterns/index.md rename to docs/patterns/index.md index 460f964c..c6309309 100644 --- a/docs/pages/patterns/index.md +++ b/docs/patterns/index.md @@ -10,9 +10,9 @@ If you would like to use backport packages, see [Backports][]. If you are wondering about public API, see [Exports][]. -[including data files]: pages/patterns/data-files -[backports]: pages/patterns/backports -[exports]: pages/patterns/exports +[including data files]: patterns/data-files +[backports]: patterns/backports +[exports]: patterns/exports ```{tableofcontents} ``` diff --git a/docs/pages/principles/design.md b/docs/principles/design.md similarity index 100% rename from docs/pages/principles/design.md rename to docs/principles/design.md diff --git a/docs/pages/principles/index.md b/docs/principles/index.md similarity index 74% rename from docs/pages/principles/index.md rename to docs/principles/index.md index 7442211b..2406bf6e 100644 --- a/docs/pages/principles/index.md +++ b/docs/principles/index.md @@ -5,8 +5,8 @@ research code. [Process recommendations][] discusses the process of writing software, and [Design recommendations][] covers some tips about writing easy to read and maintain code. -[Process recommendations]: pages/principles/process -[Design recommendations]: pages/principles/design +[Process recommendations]: principles/process +[Design recommendations]: principles/design ```{tableofcontents} diff --git a/docs/pages/principles/process.md b/docs/principles/process.md similarity index 100% rename from docs/pages/principles/process.md rename to docs/principles/process.md diff --git a/docs/pages/principles/testing.md b/docs/principles/testing.md similarity index 99% rename from docs/pages/principles/testing.md rename to docs/principles/testing.md index 313d521b..946de96f 100644 --- a/docs/pages/principles/testing.md +++ b/docs/principles/testing.md @@ -69,8 +69,8 @@ the test-case to make sure it fails when the code is broken. A good place to start writing tests is from the perspective of a user of your module or library, as described in the [Test -Tutorial](pages/tutorials/test), and [Testing with pytest -guide](pages/guides/pytest). These tests follow the "Detroit +Tutorial](tutorials/test), and [Testing with pytest +guide](guides/pytest). These tests follow the "Detroit School", focusing on behavior, avoiding testing of private attributes, minimizing the use of mocks/patches/test-doubles. @@ -393,7 +393,7 @@ run unit tests in your source folder, from your package root, use your source repository), use `pytest --pyargs {package name}`. You can set the default test path in `pyproject.toml`, see: [Configuring -pytest](pages/guides/pytest#configuring-pytest) +pytest](guides/pytest#configuring-pytest) We recommend configuring pytest to run ONLY your fastest, least demanding test suite by default. diff --git a/docs/pages/tutorials/dev-environment.md b/docs/tutorials/dev-environment.md similarity index 100% rename from docs/pages/tutorials/dev-environment.md rename to docs/tutorials/dev-environment.md diff --git a/docs/pages/tutorials/docs.md b/docs/tutorials/docs.md similarity index 97% rename from docs/pages/tutorials/docs.md rename to docs/tutorials/docs.md index 89298bc0..99ce1e99 100644 --- a/docs/pages/tutorials/docs.md +++ b/docs/tutorials/docs.md @@ -195,7 +195,7 @@ Or you can generate a table that links out to documentation for each object. ```` -See the [guide](pages/guides/docs) for more information on how to +See the [guide](guides/docs) for more information on how to integrate this into a package, and setup for nox. [sphinx]: https://www.sphinx-doc.org/ @@ -204,4 +204,4 @@ integrate this into a package, and setup for nox. [sphinx-autodoc2]: https://sphinx-autodoc2.readthedocs.io/ [mkdocs]: https://www.mkdocs.org/ [mkdocs-material]: https://squidfunk.github.io/mkdocs-material/ -[documentation guide]: pages/guides/docs +[documentation guide]: guides/docs diff --git a/docs/pages/tutorials/index.md b/docs/tutorials/index.md similarity index 87% rename from docs/pages/tutorials/index.md rename to docs/tutorials/index.md index 2613361d..26fd10c8 100644 --- a/docs/pages/tutorials/index.md +++ b/docs/tutorials/index.md @@ -12,9 +12,9 @@ start off on the right foot. Keeping in mind that too much software infrastructure can be overwhelming to those who haven't yet encountered the need for it, we introduce only the core essentials in this opinionated tutorial. From there, we recommend looking -through the section on [principles](pages/principles/index). As +through the section on [principles](principles/index). As your project grows you may find some good use for the more specific and advanced -topics covered in the [guides](pages/guides/index). +topics covered in the [guides](guides/index). ```{tableofcontents} ``` diff --git a/docs/pages/tutorials/module.md b/docs/tutorials/module.md similarity index 98% rename from docs/pages/tutorials/module.md rename to docs/tutorials/module.md index 7b3114f8..ac0d4d26 100644 --- a/docs/pages/tutorials/module.md +++ b/docs/tutorials/module.md @@ -79,7 +79,7 @@ automatically generate nice-looking HTML documentation later. Notable features: - (Optional) There is a section of one or more examples. We will revisit docstrings in the section on writing -[documentation](pages/tutorials/docs). +[documentation](tutorials/docs). [snell's law]: https://en.wikipedia.org/wiki/Snell%27s_law [numpydoc standard]: https://numpydoc.readthedocs.io/en/latest/format.html diff --git a/docs/pages/tutorials/packaging.md b/docs/tutorials/packaging.md similarity index 98% rename from docs/pages/tutorials/packaging.md rename to docs/tutorials/packaging.md index 70dbdf41..4aeab750 100644 --- a/docs/pages/tutorials/packaging.md +++ b/docs/tutorials/packaging.md @@ -125,4 +125,4 @@ In [1]: snell? For more about packaging, also see our [packaging guide][]. [version control with git]: https://swcarpentry.github.io/git-novice/ -[packaging guide]: pages/guides/packaging-simple +[packaging guide]: guides/packaging-simple diff --git a/docs/pages/tutorials/test.md b/docs/tutorials/test.md similarity index 99% rename from docs/pages/tutorials/test.md rename to docs/tutorials/test.md index 73aec350..212d636a 100644 --- a/docs/pages/tutorials/test.md +++ b/docs/tutorials/test.md @@ -139,4 +139,4 @@ Consult the [pytest documentation][] for more. For more advanced pytest suggestions, see our [pytest guide][]. [pytest documentation]: https://docs.pytest.org/en/latest/ -[pytest guide]: pages/guides/pytest +[pytest guide]: guides/pytest diff --git a/noxfile.py b/noxfile.py index 60573f2d..0e100000 100755 --- a/noxfile.py +++ b/noxfile.py @@ -425,7 +425,7 @@ def pc_bump(session: nox.Session) -> None: session.install("lastversion>=3.4") versions = {} pages = [ - Path("docs/pages/guides/style.md"), + Path("docs/guides/style.md"), Path("{{cookiecutter.project_name}}/.pre-commit-config.yaml"), Path(".pre-commit-config.yaml"), ] @@ -494,11 +494,11 @@ def gha_bump(session: nox.Session) -> None: """ Bump the GitHub Actions. """ - pages = list(Path("docs/pages/guides").glob("gha_*.md")) + pages = list(Path("docs/guides").glob("gha_*.md")) pages.extend(Path("{{cookiecutter.project_name}}/.github/workflows").iterdir()) - pages.append(Path("docs/pages/guides/style.md")) - pages.append(Path("docs/pages/guides/tasks.md")) - pages.append(Path("docs/pages/guides/coverage.md")) + pages.append(Path("docs/guides/style.md")) + pages.append(Path("docs/guides/tasks.md")) + pages.append(Path("docs/guides/coverage.md")) full_txt = "\n".join(page.read_text() for page in pages) # This assumes there is a single version per action