Skip to content

DOC: refactor documentation

Colm Talbot requested to merge update-docstrings into master

I planned to update a few docstrings and wound up pretty substantially refactoring the docs to do the following:

  • add a full API reference
  • document all of the executables
  • update the structure/table of contents to more naturally expose the API and executables

This doesn't change the behaviour of any code, except to print more informative doc strings for individual executables, currently they all print the generic bilby_pipe help.

It would be nice to automate the documentation of the executables, but that's out of scope for this change.

Edited by Colm Talbot

Merge request reports