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

Fix Sphinx bugs to enable readthedocs #147

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MooreZheng
Copy link
Collaborator

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 #145 and #92

@kubeedge-bot kubeedge-bot added the kind/bug Categorizes issue or PR as related to a bug. label Sep 20, 2024
@kubeedge-bot
Copy link
Collaborator

[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:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@MooreZheng MooreZheng requested review from hsj576 and removed request for jaypume and Poorunga September 20, 2024 14:14
@kubeedge-bot kubeedge-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 20, 2024
@MooreZheng MooreZheng requested a review from jaypume September 20, 2024 14:14
@MooreZheng MooreZheng self-assigned this Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants