No documentation is generated for click-decorated entrypoints or groups of entrypoints.
This is a known issue, but the only fix would be to use specialized sphinx plugins and explicitly write special commands like :click: ... in the .rst docs files: https://stackoverflow.com/questions/39392753/how-can-i-document-click-commands-using-sphinx
For the time being, we decided to do nothing, as not many functions are affected anyway.
POST-MERGE
[x] Note that currently we are setting the branch of this PR (i.e. rtd) as the default branch for RTD. Once we merge, the default branch must be changed to main!
[x] Add link to RTD on GitHub frontpage under "description".
Closes #5.
It also adds nice badges on the
README.md, including the one for RTD.To test: https://morphoclass.readthedocs.io/en/latest/
NOTE
No documentation is generated for
click-decorated entrypoints or groups of entrypoints. This is a known issue, but the only fix would be to use specialized sphinx plugins and explicitly write special commands like:click: ...in the.rstdocs files: https://stackoverflow.com/questions/39392753/how-can-i-document-click-commands-using-sphinx For the time being, we decided to do nothing, as not many functions are affected anyway.POST-MERGE
rtd) as the default branch for RTD. Once we merge, the default branch must be changed tomain!