Can it help me fix broken documentation builds?

Yes, it includes a troubleshooting guide for common Sphinx errors, autodoc failures, and Read the Docs configuration issues.

Does it support the Diátaxis framework?

Absolutely. It uses the Diátaxis framework to help you organize documentation into Tutorials, How-to Guides, Technical Reference, and Explanations.

What documentation frameworks does this skill support?

The skill provides comprehensive support and ready-to-use templates for Sphinx, MkDocs, and Jupyter Book, tailored for scientific and research software.

How does it handle math and code examples?

The skill configures extensions like MathJax for LaTeX rendering and provides workflows for integrating live Jupyter notebooks into your documentation.

Scientific Python Documentation

Name: Scientific Python Documentation
Author: uw-ssec

byuw-ssec

•

Learning & Documentation

Builds and manages professional documentation for scientific Python projects using Sphinx, MkDocs, and community-standard best practices.

This skill provides a comprehensive toolkit for Research Software Engineers (RSEs) and scientists to create professional, accessible, and well-structured documentation for complex Python packages. It automates the setup of Sphinx and MkDocs, enforces NumPy-style docstring standards, and implements the Diátaxis framework to ensure clarity across tutorials and API references. Whether you need to integrate Jupyter notebooks, configure Read the Docs, or resolve complex build errors, this skill provides the specialized templates and domain-specific guidance required for the scientific computing ecosystem.

Key Features

01Diátaxis framework implementation for structured user guides

02Accessibility-first guidance for scientific figures and color contrast

03Seamless Jupyter notebook integration for computational narratives

04Automated Sphinx and MkDocs configuration for scientific packages

05NumPy-style docstring generation and validation templates

0616 GitHub stars

Use Cases

01Setting up a new documentation site for a SciPy-ecosystem library

02Converting legacy docstrings to standardized NumPy format for API references

03Troubleshooting and fixing Sphinx build warnings or Read the Docs deployment failures

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add uw-ssec/rse-plugins scientific-documentation

For use in Claude.ai and ChatGPT

Download Skill