Wan2.1/docs
Claude 28a931100b
docs: add Sphinx documentation framework
Sets up Sphinx documentation infrastructure for generating
comprehensive API documentation and user guides.

Sphinx Configuration (docs/conf.py):
- RTD (Read the Docs) theme
- Autodoc for automatic API documentation
- Napoleon for Google/NumPy style docstrings
- Intersphinx for cross-referencing external docs
- MyST parser for Markdown support
- Coverage and TODO extensions

Documentation Structure (docs/index.rst):
- Getting Started guides
- User Guide sections
- API Reference structure
- Development documentation
- Quick links and features overview
- System requirements
- Quick start examples

Build System (docs/Makefile):
- Standard Sphinx build targets
- HTML output generation
- Clean and build commands

Planned Documentation:
- Installation guide
- Quickstart tutorial
- Pipeline documentation
- Model architecture guides
- Configuration reference
- Distributed training guide

Build Commands:
- make html          # Build HTML documentation
- make clean         # Clean build directory
- make html-open     # Build and open in browser

Benefits:
- Professional API documentation
- Searchable reference material
- Improved discoverability
- Better user onboarding
- Integration with Read the Docs
2025-11-19 04:25:31 +00:00
..
conf.py docs: add Sphinx documentation framework 2025-11-19 04:25:31 +00:00
index.rst docs: add Sphinx documentation framework 2025-11-19 04:25:31 +00:00
Makefile docs: add Sphinx documentation framework 2025-11-19 04:25:31 +00:00