As you make changes to the astrodbkit repository on Github, you may find that the documentation needs updating. Luckily, we use the invaluable Sphinx and the awesome ReadTheDocs to generate the documentation so this is fairly simple.
First, make sure you update the appropriate doc strings (those informative green bits just below the function definition) as this is what Sphinx will use to generate the documentation!
Start in the top level
astrodbkit directory and generate the documentation from the module docstrings with
sphinx-build docs astrodbkit -a
Then cd into the
docs directory and rebuild the html files with
Now move back to the top level directory and add, commit, and push your changes to Github with something like
git add /docs
git commit -m "Updated the documentation for methods x, y, and z."
git push origin <your_branch>
All set! Refresh the page (after a few minutes so ReadTheDocs can build the pages) and make sure everything is to your liking. Well done.