docs: Fix readthedocs issues. #800
Merged
Conversation
This file contains hidden or 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
microbit-carlos
force-pushed
the
docs-theme-fix
branch
6 times, most recently
from
5c7f16e to
3740f77
Compare
Collaborator
Author
|
Don't know why the readthedocs builds are stopping at the point it's meant to create a venv and it doesn't continue, will need to look into it tomorrow. Edit: Turns out readthedocs now requires you to have |
microbit-carlos
force-pushed
the
docs-theme-fix
branch
3 times, most recently
from
482a125 to
b6865f4
Compare
microbit-carlos
changed the title
Add required .readthedocs.yml and docs/requirements.txt files.
Fixes error:
NameError: name 'html_theme' is not defined
Also fixes a couple of issues highlighted by the sphinx build
output.
microbit-carlos
force-pushed
the
docs-theme-fix
branch
from
b6865f4 to
28002b2
Compare
microbit-carlos
commented
Feb 22, 2024
Comment on lines
-343
to
-344
| # Example configuration for intersphinx: refer to the Python standard library. | ||
| intersphinx_mapping = {'http://docs.python.org/': None} |
Collaborator
Author
There was a problem hiding this comment.
This should stop cpython docs from being included, which fixes #729.
microbit-carlos
commented
Feb 22, 2024
| :maxdepth: 2 | ||
| :caption: Developer Guide | ||
|
|
||
| devguide/installation |
Collaborator
Author
There was a problem hiding this comment.
This file no longer exists.
microbit-carlos
changed the title
Collaborator
Author
|
This is isolated to the docs, so I'll merge it to resolve the issues with ReadTheDocs and get those builds going again. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The first thing is that now readthedocs forces you to have
.readthedocs.ymlfile, and the second was this error, which was triggered when readthedocs stopped settinghtml_themeautomatically tosphinx_rtd_theme:PR also fixes a couple of issues highlighted by the sphinx build output.
Test deployment: https://microbit-micropython--800.org.readthedocs.build/en/800/