Repository navigation
MkDocs template option - #2
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are recorded for the MkDocs backend addition.
No open issues 🎉
What changed in this PR
Adds --docs mkdocs to the project generator, offering MkDocs Material with a docstring-based API reference alongside the existing Jupyter Book backend.
Changes:
- Adds MkDocs dependencies, configuration, SCENE styling, and a GitHub Pages workflow.
- Extends backend checks and adds an end-to-end MkDocs build test.
- Documents backend selection and updates setup guidance and repository notes.
| File | Description |
|---|---|
TODO.md |
Removes previous work items and updates repository-move notes. |
tests/test_cli.py |
Checks backend-specific output, shared images, dependencies, and MkDocs builds. |
src/scene_repo_template/skeleton/mkdocs/mkdocs.yml.tmpl |
Configures Material, automatic API navigation, and docstring rendering. |
src/scene_repo_template/skeleton/mkdocs/dot-github/workflows/docs.yml |
Builds documentation and deploys it to GitHub Pages. |
src/scene_repo_template/skeleton/mkdocs/docs/stylesheets/scene.css |
Adds SCENE colours and footer styling. |
src/scene_repo_template/skeleton/mkdocs/docs/index.md.tmpl |
Provides the generated documentation homepage. |
src/scene_repo_template/cli.py |
Registers the MkDocs backend and its dependencies and README guidance. |
docs/index.md |
Corrects introductory wording. |
docs/guides/using-the-template.md |
Explains backend selection, switching, and publishing. |
docs/guides/development-guide.md |
Renames the page heading to “Collaborating on code.” |
Review effort: Balanced
C-Achard
force-pushed
the
cy/scene-template-mkdocs
branch
from
November 3, 2026 17:11
1738e85 to
4e9d6e5
Compare
C-Achard
force-pushed
the
cy/scene-template-mkdocs
branch
from
November 3, 2026 17:14
4e9d6e5 to
62c2f14
Compare
deruyter92
approved these changes
Nov 4, 2026
C-Achard
force-pushed
the
cy/scene-template-mkdocs
branch
2 times, most recently
from
November 4, 2026 10:18
49717fa to
981896d
Compare
…rove footer design
which breaks on pymdown-extensions 12.2+ (Highlight now requires `md`).
C-Achard
force-pushed
the
cy/scene-template-mkdocs
branch
from
November 4, 2026 10:39
981896d to
dc241d6
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
--docs mkdocsoption for MkDocs Material template. Meant for projects needing an API reference built from code directly.