I used pdoc3 to automatically generate documentation from the docstrings at the beginning of each python class/function by executing the following
pdoc3 --html ambit_stochastics
The resulting documentation can be found at https://danleonte.github.io/Ambit_Stochastics/index.html
- Can I remove the
ambit_stochasticsfromambit_stochastics.helperson the index page and, subsequently, on all of the subpages? It seems unnecessary and wordy. - Can I edit the index page ( the one that pops up when accessing the link) to add some introductory text? how about other templates?
Not sure about your #1 point without editing the template, but you can tackle #2 by including a module docstring in your
ambit_stochastics/__init__.pylike pdoc does. This ten renders on the main module page, along with its TOC for titles: https://pdoc3.github.io/pdoc/doc/pdoc/