Skip to content

Instantly share code, notes, and snippets.

@lamoboos223
Last active January 19, 2025 10:00
Show Gist options
  • Save lamoboos223/2fc685016500746d8bbac3d7a45c5af4 to your computer and use it in GitHub Desktop.
Save lamoboos223/2fc685016500746d8bbac3d7a45c5af4 to your computer and use it in GitHub Desktop.
sphinx a gui documentation

Create docs/ directory

mkdir docs/
cd docs/
pip install sphinx sphinx-rtd-theme myst-parser recommonmark
sphinx-quickstart # interactive shell for creating a sphinx settings
# select yes for seperating source from build
cd sources/
touch a.md b.md c.md
cd ..

add some content to these files.

make html

now you can access your GUI docs via browser

open _build/html/index.html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment