Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Read-the-docs's autodoc doesn't work #65

Open
matsui528 opened this issue Nov 22, 2023 · 0 comments
Open

Read-the-docs's autodoc doesn't work #65

matsui528 opened this issue Nov 22, 2023 · 0 comments
Labels
help wanted Extra attention is needed

Comments

@matsui528
Copy link
Owner

matsui528 commented Nov 22, 2023

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

image

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`

image

@matsui528 matsui528 added the help wanted Extra attention is needed label Nov 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant