📝🩹 Fix documentation on read the docs #13
Merged
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.
On read the docs we got the following error message:
The motivation for the mentioned module is, that Sphinx reads the docstrings and generates automatically rst files from it.
This current setup works fine on our machines, but not on read the docs.
Luckily we are not the only ones with this issue: readthedocs/readthedocs.org#1139
So I used the same setup like the mozilla people: openwpm/OpenWPM#900
Additionally I added the folder of the generated rst-files to gitignore and fixed a docstring in one function.
In the future we have to be careful to indent multiline docstrings.