API docs: include multiple versions: master, latest & past releases

transientskp / pyse

Python Source Extractor

BSD 2-Clause "Simplified" License

11 stars 5 forks source link

API docs: include multiple versions: master, latest & past releases #100

Open HannoSpreeuw opened 2 days ago

HannoSpreeuw commented 2 days ago

[ ] Configure Sphinx
[ ] add API docs
[ ] deploy to RTD/GH pages

HannoSpreeuw commented 2 days ago

Perhaps you could work from documentation_through_Sphinx, although it has little more than master, i.e.

Sphinx boilerplate from running "sphinx-quickstart".

README added to _index.rst_ and uncommenting
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))

such that README.rst is picked up from the top level folder.