search

kubeedge / ianvs

Distributed Synergy AI Benchmarking
https://ianvs.readthedocs.io
Apache License 2.0
113 stars 46 forks source link

Ianvs documents fails to update with Readthedoc website #145

Open MooreZheng opened 1 month ago

MooreZheng commented 1 month ago

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 https://github.com/kubeedge/ianvs/issues/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 commented 1 month ago

There are configuration and package-absent errors with Sphinx codes

  1. 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
  2. sphinx_rtd_theme is no longer a hard dependency since version 1.4.0, which should be tackled too.

Accordingly, here are solutions https://github.com/kubeedge/ianvs/pull/147 to this issue.