mirror of
https://github.com/Wan-Video/Wan2.1.git
synced 2025-12-15 19:53:22 +00:00
28a931100b
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
31 lines
865 B
Makefile
31 lines
865 B
Makefile
# Makefile for Sphinx documentation
|
|
|
|
# You can set these variables from the command line.
|
|
SPHINXOPTS =
|
|
SPHINXBUILD = sphinx-build
|
|
SOURCEDIR = .
|
|
BUILDDIR = _build
|
|
|
|
# Put it first so that "make" without argument is like "make help".
|
|
help:
|
|
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
.PHONY: help Makefile clean
|
|
|
|
# Clean build directory
|
|
clean:
|
|
rm -rf $(BUILDDIR)/*
|
|
|
|
# Build HTML documentation
|
|
html:
|
|
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
|
|
# Build and open HTML documentation
|
|
html-open: html
|
|
open $(BUILDDIR)/html/index.html || xdg-open $(BUILDDIR)/html/index.html
|
|
|
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
%: Makefile
|
|
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|