search

nteract / bookstore

📚 Notebook storage and publishing workflows for the masses
https://bookstore.readthedocs.io
BSD 3-Clause "New" or "Revised" License
202 stars 23 forks source link

Python API docs are broken/redundant #122

Closed mpacer closed 5 years ago

mpacer commented 5 years ago

Right now the readthedocs doesn't show any autodoc documentation being built for the Python API: image

This is a fairly straightforward RST issue (number of underscore characters underneathe one of the rst header names in the store_client.rst).

But in addition, it looks like the methods for the handlers are being displayed twice, once from the class docstring's Methods section, once from each of the method's functional docstrings. The latter do not include the self parameter: image

@willingc What is the right way to go here to make the documentation make sense (ignoring the lack of the docs build which I'll fix with a small PR shortly).

willingc commented 5 years ago

123 (Thank you) fixed a problem. There is something up with the RTD build and the latest Sphinx changes and RTD.

I think the duplication is coming from the Class Docstring being followed closely by the method docstrings. We likely need to add some distinction either via css or headings.

willingc commented 5 years ago

124 fixed the build configuration. Working on polishing the docs in a separate PR.

willingc commented 5 years ago

Hi @mpacer. I merged two PRs cleaning up the doc build and the formatting. I've added some additional headings on the autodoc pages. Please take a look. If you have any desired changes, either leave a note here, edit directly, or open a PR. Thanks!

willingc commented 5 years ago

Going to close this @mpacer since I think this is resolved.