Revival 4/4: MkDocs documentation (Material + mkdocstrings) replacing Sphinx - #5
Merged
Merged
Conversation
- mkdocs.yml with Material theme, mkdocstrings API pages generated from the docstrings, autorefs cross-references, Mermaid, tabs and admonitions - New content: home, installation, quickstart, a user guide (how it works, data & study areas, grids & mapping, feature engineering, prediction & evaluation), API reference per module, changelog/contributing (included from the repo files) and a citing page; figures generated with the synthetic generator; every code example was executed - Docstrings converted from Sphinx roles to mkdocstrings cross-references - Docs workflow: strict build on PRs, deploy to the gh-pages branch on pushes to master (replaces the committed Sphinx HTML) - `docs` extra in pyproject; README points to the site Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FtZdc2gGrDh4PGSLyT9yRE
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
1 participant
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.
Summary
Stacked on #4.
mkdocs.ymlwith the Material theme, API pages generated from docstrings by mkdocstrings, autorefs, Mermaid, tabs and admonitionsmkdocs gh-deployto thegh-pagesbranch on pushes tomaster(keeps https://adaj.github.io/predspot/ working and replaces the committed Sphinx HTML)docsextra inpyproject.toml; README points to the sitemkdocs build --strictpasses.🤖 Generated with Claude Code
https://claude.ai/code/session_01FtZdc2gGrDh4PGSLyT9yRE