Numpy-style doc generation and convention
diegoasua opened this issue · comments
I have a little issue and a question:
- I am unable to generate locally an
.html
docs file withsphinx
. Running
$ sphinx-apidoc ../sashimi -o source/
$ make html
in ..\docs
throws an error after the second command:
Running Sphinx v3.2.1
Extension error:
Could not import extension myst_parser (exception: No module named 'myst_parser')
- It is not clear to me, regarding numpydoc docstring conventions, whether methods of the classes are documented below the method name or just below the class itself
Update: I fixed the sphinx issue running:
pip install myst-parser
that was indeed the solution! Can I close?
My question (2.) is still left to be answered 💣
They should for sure be documented as functions are. We can decide for the main classes (eg interface abstract classes) to also have the methods section as a summary in the class header.
Ok thanks. Then I close this.