search

SMAT-Lab / Scalpel

Scalpel: The Python Static Analysis Framework
Apache License 2.0
295 stars 46 forks source link

Setup reathedocs build #82

Closed tristanlatr closed 2 years ago

tristanlatr commented 2 years ago

Add readthedocs.yml and create the Scalpel[docs] extra.

tristanlatr commented 2 years ago

Hi @Jarvx, the setup with sphinx-readthedocs should normally be complete.

Just one minor thing that could be improved:

by default 2022-09-08 at 12 13 13 PM

Looks like you need to give permission to reathedocs to the scalpel repo in order to have the ReadTheDocs check display in the Github PR. Maybe it's not very important at the moment

The docs can still be manually reviewed if we go to the readthedocs.org site, for instance, here is the documentation preview for this PR: https://python-scalpel--82.org.readthedocs.build/en/82/

Anyway you can merge this PR, it's still a big move forward.

tristanlatr commented 2 years ago

Ok, it looks like many of the undocumented public API members do not show up in the HTML. I can't find any option to turn on documentation for those members. I think I'll change the config and make use of pydoctor, which will behave correctly with the required __all__ variables addition.

Jarvx commented 2 years ago

@tristanlatr Thanks, this is a indeed a very good way to handle. I will try to use all slots for each of Python module files in this project.

Jarvx commented 2 years ago

Permissions have been updated.