scientific-documentation

Structure scientific Python documentation by organizing content into four distinct types: tutorials, how-to guides, reference/API docs, and explanations. This Diátaxis-aligned architecture ensures consistent, high-quality output across your project.

Integrate Jupyter notebooks into Sphinx documentation using nbsphinx or myst_nb extensions. This notebook integration supports reproducible scientific narratives directly within your documentation framework.

The framework supports both Sphinx and MkDocs, providing ready-to-use templates and configurations. Sphinx includes autodoc, autosummary, and Napoleon, while MkDocs uses the material theme for scientific software documentation.

Ensure accessibility in scientific software documentation by following built-in best practices for alt text, color contrast, and semantic structure. The framework includes accessibility guidelines and automated accessibility checks.

Automate documentation workflows and accessibility checks using optional scripts included with the framework. These scripts streamline the creation and maintenance of scientific Python documentation.

Host scientific Python documentation on Read the Docs or GitHub Pages using the hosting guidance provided with the framework. The templates include configurations for both platforms to ensure consistent deployment.