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.

Sign up for GitHub

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

Jump to bottom

Ianvs documents fails to update with Readthedoc website #145

Open

MooreZheng opened this issue Sep 20, 2024 · 1 comment

Assignees

Labels

kind/bug

Collaborator

MooreZheng commented Sep 20, 2024

What happened:
Several documents have been committed but the Readthedoc website does not update.

What you expected to happen:
Documents updated accordingly.

How to reproduce it (as minimally and precisely as possible):
This issue arises when new website documents are updated, e.g., documents in #92.

Anything else we need to know?:
The required .readthedocs.yaml configuration file was not found at repository, leading to the website building error.
Reference: https://docs.readthedocs.io/en/stable/config-file/index.html

MooreZheng added the kind/bug label

MooreZheng self-assigned this

MooreZheng mentioned this issue

Fix Sphinx bugs to enable readthedocs #147

Open

Collaborator Author

MooreZheng commented Sep 20, 2024

There are configuration and package-absent errors with Sphinx codes

Readthedocs.yaml is missing to build readthedocs projects. References are as https://stackoverflow.com/questions/60364789/how-do-i-correctly-start-using-readthedocs-yml and https://docs.readthedocs.io/en/stable/config-file/index.html
sphinx_rtd_theme is no longer a hard dependency since version 1.4.0, which should be tackled too.

Accordingly, here are solutions #147 to this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment