Repository navigation
Switch documentation to MkDocs Material and dynamically generate tutorial figures (#516) - #518
Merged
Merged
Conversation
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.
Closes #516
Summary of Changes
mkdocs,mkdocs-material, andmkdocstrings[python].mkdocs.ymlwith Material theme, palette toggle (light/dark), code-copying, navigation features, andmkdocstringswith NumPy docstring support.docs/index.rst->docs/index.mddocs/tutorial.rst->docs/tutorial.mddocs/api.rst->docs/api.mddocs/references.rst->docs/references.mddocs/generate_tutorial_figures.pyas an MkDocs build hook (on_pre_build) to dynamically generate tutorial figures (steps 5–10: condition factors, cell embeddings, eigenstate factors, gene factors, gene expression, and weighted projections).step2_r2x.pngandstep3_fms.png) indocs/assets/tutorial_images/.docs/conf.py) and old static images indocs/_static/..gitignoreto ignore dynamically generated tutorial figures and thesite/build directory..github/workflows/documentation.ymlto build docs viauv run --group docs mkdocs buildand deploy thesiteartifact to GitHub Pages.