Read-the-docs's autodoc doesn't work
matsui528 opened this issue · 0 comments
matsui528 commented
Read-the-docs's autodoc (the function to automatically read the docstring inside codes) doesn't work. Any help?
We should see the docstring here, but cannot see anything.
https://rii.readthedocs.io/en/latest/source/api.html
The corresponding rst file is as follows. The original file is here.
API Reference
==============
.. automodule:: rii
Reconfigurable Inverted Index (Rii)
---------------------------------------
.. autoclass:: rii.Rii
:members:
:undoc-members:
Strangely, if we render the document manually, it works.
- Open a clean codespace
- Run the followings
cd docs
pip install -r requirements.txt
make html
- Then you can see the HTML files by
python -m http.serer 8000
# Go to `docs/_build/html`