This repository has been archived by the owner on Sep 8, 2024. It is now read-only.
Fix readthedocs build #2749
Merged
Fix readthedocs build #2749
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
- Rename it to .readthedocs.yml - Fix doc requirements path
Tries to make it clearer when module name needs to be inserted manually.
forslund
added
the
Type: Bug - quick
devs-mycroft
added
the
CLA: Yes
|
Voight Kampff Integration Test Succeeded (Results) |
krisgesling
approved these changes
Nov 9, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
After readthedocs was fixed enough to update again a couple of issues were observed, the most obvious one that the docs for MycroftSkill derived classes are missing. See here
This was due to
xdgnot being mocked when generating the docs, and thus erroring out when sphinx imported those modules. This addsxdgas aautodoc_mocked_import.Finding this out I realized the same isse ẃas causing the previous issue with
yamlso that has been cleaned up as well.I also noticed that the
.readthedocsfile was not named correctly and wasn't actually used. This renames it and fixes an incorrect path making it usable.How to test
I generated readthedocs from this branch here Make sure the MycroftSkills module and related modules are generated properly.
Contributor license agreement signed?
CLA [ Yes ]