scientific-documentation
Use when the user asks about setting up docs for a Python package, configuring Sphinx or MkDocs, writing NumPy-style docstrings, or deploying to Read the Docs. Set up and maintain documentation for scientific Python packages. Covers Sphinx, MkDocs, NumPy-style docstrings, Diataxis framework, accessibility standards, and documentation hosting with Read the Docs.
Pinned to revision 1bca4bbdf059, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/scientific-documentation/SKILL.md
- skills/scientific-documentation/assets/index-template.md
- skills/scientific-documentation/assets/mkdocs-scientific.yml
- skills/scientific-documentation/assets/noxfile-docs.py
- skills/scientific-documentation/assets/readthedocs.yaml
- skills/scientific-documentation/assets/sphinx-conf-scientific.py
- skills/scientific-documentation/references/accessible-documentation.md
- skills/scientific-documentation/references/common-issues.md
- skills/scientific-documentation/references/diataxis-framework.md
- skills/scientific-documentation/references/docstring-examples.md
- skills/scientific-documentation/references/notebook-integration.md
- skills/scientific-documentation/references/sphinx-extensions.md
- skills/scientific-documentation/scripts/generate-api-docs.py
Every link opens the file at its source, pinned to the revision this page describes.