Skip to content

MkDocs template option - #2

Merged
C-Achard merged 8 commits into
cy/scene-cookiecutterfrom
cy/scene-template-mkdocs
Nov 4, 2026
Merged

C-Achard merged 8 commits into
cy/scene-cookiecutterfrom
cy/scene-template-mkdocs

Conversation

@C-Achard

@C-Achard C-Achard commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

Adds --docs mkdocs option for MkDocs Material template. Meant for projects needing an API reference built from code directly.

@C-Achard C-Achard self-assigned this Nov 3, 2026
@C-Achard
C-Achard requested a balanced review from Copilot November 3, 2026 15:48

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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
C-Achard force-pushed the cy/scene-template-mkdocs branch from 1738e85 to 4e9d6e5 Compare November 3, 2026 17:11
@C-Achard
C-Achard added this pull request to stack #4 November 3, 2026 17:12
@C-Achard
C-Achard force-pushed the cy/scene-template-mkdocs branch from 4e9d6e5 to 62c2f14 Compare November 3, 2026 17:14
@C-Achard
C-Achard requested a review from deruyter92 November 3, 2026 17:19
@C-Achard
C-Achard force-pushed the cy/scene-template-mkdocs branch 2 times, most recently from 49717fa to 981896d Compare November 4, 2026 10:18
@C-Achard
C-Achard force-pushed the cy/scene-template-mkdocs branch from 981896d to dc241d6 Compare November 4, 2026 10:39
@C-Achard
C-Achard merged commit 9793788 into main Nov 4, 2026
8 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants