Documentation

[HadleyBN]

External Package Changes

• Make sure docstrings reference 'column name' (Python) not 'field name' (R)
• Put references in the format you see in DSR (at the end) - saw some issues in confidence_intervals.py for instance - double check how this is done
• Add examples into the docstrings of every exported function - check if confidence interval functions should all be exported (this is documented in a issue Review and Checks #112 )
• Add documentation for dobsons functions

Internal Changes

• Add comments to the functions in validation and other scripts with scarce comments. This will aid in future development and debugging.

Automated docs with Sphinx

• Docs are currently being hosted on readthedocs, but it would be better if they were hosted on GitHub pages.
• Ensure that docstrings are in the correct format, to ensure that the docs are generated properly.
• Automate the process of uploading to GitHub Pages using GitHub Actions.

Guidance on using Sphinx

• py -m pip install sphinx
• mkdir docs
• cd docs/
• py -m sphinx.cmd.quickstart
• make html
• make clean
• sphinx-apidoc -o source/ ../PHStatsMethods
  ○ You may need to put in the full path to the sphinx-apidoc, you can find it using:
  o py -m pip show sphinx
  o You'll need to navigate up a couple of levels and then find Python/Python39/Scripts
  ○ Alternatively, try sphinx-autogen -o source/ ../PHStatsMethods
• make html (equivalent of sphinx-build)