Fix Read The Docs Build #567
Merged
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
|
Addresses: #475 |
utzig
reviewed
Aug 20, 2020
|
I have a personal preference for not hiding files though I would prefer more tools allowed for putting stuff in a |
vermeeren
added
bug
The python version is to try to make sure it uses at least 3.5 as that is what the setup.py file says should work. We also try to get it to install the packages as required in the setup.py file. I am very out of date with Python packaging though.
vermeeren
approved these changes
Aug 20, 2020
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.
With this configuration in place it seems to pass: https://readthedocs.org/projects/breathe/builds/
It seemed to previously be running with Python 2, I guess? Given that it was failing on annotations. https://readthedocs.org/projects/breathe/builds/11704046/
The config opts into the v2 settings for read the docs which seems to run Python 3 by default but we go further to set the Python version to 3.5 and ask it to install the dependences from setup.py.
I am very out of date with the Python ecosystem though so it might that there are better ways. Seems to work though.
Though oddly,
https://breathe.readthedocs.io/en/readthedocs/shows the old version with Sphinx 1.2.2 referenced at the bottom but appendingindex.htmlto the end (https://breathe.readthedocs.io/en/readthedocs/index.html) seems more up to date and references Sphinx 3.2.1. That said, I have no idea what the docs are meant to look like at the moment so maybe they're both different kinds of wrong. Not sure of the best way to resolve theindex.htmlissue though. Well we can just make sure we link to that directly but it is a shame if that is necessary.