| name | sphinx-5-generate-api-documentation |
| description | Sub-skill of sphinx: 5. Generate API Documentation (+1). |
| version | 1.0.0 |
| category | development |
| type | reference |
| scripts_exempt | true |
5. Generate API Documentation (+1)
5. Generate API Documentation
sphinx-apidoc -o docs/source/api src/mypackage -f -e -M
sphinx-build -b html docs/source docs/build/html
sphinx-build -b html docs/source docs/build/html -v
rm -rf docs/build && sphinx-build -b html docs/source docs/build/html
6. MyST Markdown Support
extensions = [
'myst_parser',
]
myst_enable_extensions = [
'amsmath',
'colon_fence',
'deflist',
'dollarmath',
'fieldlist',
'html_admonition',
'html_image',
'replacements',
'smartquotes',
'strikethrough',
'substitution',
'tasklist',
]
myst_heading_anchors = 3
myst_footnote_transition = True
<!-- docs/source/guide/overview.md -->
# Overview
This guide provides an overview of MyProject.