kubeedge / ianvs

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

Fix Sphinx bugs to enable readthedocs #147

Open MooreZheng opened 2 months ago

MooreZheng commented 2 months ago

What type of PR is this? /kind bug

What this PR does / why we need it: There are configuration and package-absent errors that are fixed with Sphinx codes in this PR.

  1. Add readthedocs.yaml to enable Sphinx, which is necessary for building 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. Add the try/except install session, add the extension and import the package for sphinx_rtd_theme. That is because sphinx_rtd_theme is no longer a hard dependency since version 1.4.0

Which issue(s) this PR fixes: Related to https://github.com/kubeedge/ianvs/issues/145 and https://github.com/kubeedge/ianvs/issues/92

kubeedge-bot commented 2 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: To complete the pull request process, please assign moorezheng after the PR has been reviewed. You can assign the PR to them by writing /assign @moorezheng in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/kubeedge/ianvs/blob/main/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment