Fix documentation on read the docs #715
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
- also include faster direct sphinx call in Makefile in case people want to skip tox.
- on python 3, the code blocks in markdown files were failing, this makes them work again.
jminor
approved these changes
May 21, 2020
Codecov Report
@@ Coverage Diff @@
## master #715 +/- ##
=======================================
Coverage 81.88% 81.88%
=======================================
Files 72 72
Lines 2755 2755
=======================================
Hits 2256 2256
Misses 499 499
Continue to review full report at Codecov.
|
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.
It turns out that we needed to add the "recommonmark" plugin to our plugins in sphinx to get the code blocks to get rendered correctly from markdown files.
The bug this fixes is the table of contents looking like this:
(note all the
{in the table of contents)For a preview of this, see:
https://opentimelineio-ssteinbach.readthedocs.io/en/documentation_busted_rtd/