Add instructions to build documentation #822
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.
Pull request
This PR adds a
README.md
in thedocs
directory with a short explanation on how to build the docs. This might be especially useful for people coming from non-technical backgrounds in order to be able to contribute to the documentation.How Has This Been Tested?
The requirements have been frozen by installing the latest versions of
sphinx-argparse
andpdfminer.six
and runningpip freeze > requirements.txt
.Afterwards, I've created a virtual environment, installed the requirements and checked that the build was successful.
Checklist