Fix Sphinx bugs to enable readthedocs #147
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
MooreZheng
requested review from
hsj576
and removed request for
jaypume and
Poorunga
kubeedge-bot
added
the
size/M
Signed-off-by: MooreZheng <zimu.zheng@hotmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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
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