xixu-me
cfb8290dea
- Complete documentation structure with index, quickstart, examples, and API reference - Sphinx configuration with RTD theme, MyST parser, and autodoc - GitHub Actions workflow for automated documentation building and deployment - Local development tools (Makefile, build scripts) - Comprehensive examples covering basic usage, security, and performance - API documentation for core, CLI, and exceptions modules
18 lines
418 B
Plaintext
18 lines
418 B
Plaintext
# Documentation requirements for Sphinx
|
|
sphinx>=7.1.0
|
|
sphinx-rtd-theme>=2.0.0
|
|
myst-parser>=3.0.0
|
|
sphinxcontrib-napoleon>=0.7
|
|
|
|
# Additional Sphinx extensions
|
|
sphinx-autobuild>=2021.3.14
|
|
sphinx-copybutton>=0.5.2
|
|
sphinxext-opengraph>=0.9.0
|
|
sphinx-autodoc-typehints>=1.25.0
|
|
|
|
# Alternative modern theme (optional)
|
|
furo>=2024.1.29
|
|
|
|
# Main package dependencies (needed for autodoc to import modules)
|
|
zstandard>=0.19.0,<1.0.0
|