Skip to content

go2m/readthedoc-test

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Template for the Read the Docs tutorial

Automatic documentation generation using Sphinx-docs. I happen to be using a Readthedocs theme but there are many you can use. See the Sphinx documentation.

My repo has a GitHub Action set up to build the documentation on any push to the main branch. My repo is modeled off: https://github.com/maltfield/rtd-github-pages

Reference for simple Sphinx with sphinx-apidoc https://shunsvineyard.info/2019/09/19/use-sphinx-for-python-documentation

Using this auto generation: https://sphinx-autoapi.readthedocs.io/en/latest/index.html

pip install sphinx-autoapi

Releases

No releases published

Packages

No packages published

Languages