Add Doc/requirements.txt for Read the Docs build #260
Merged
Conversation
This file contains hidden or 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
The documentation build uses docstrings from the code, and so it needs the code to be importable. We already use a fake _ldap module for cases where the C compiler is not available, like on Read the Docs. Another issue on Read the Docs is that the pyasn1 dependency needs to be installed. This can't be done automatically via setup.py install, as that would attempt to build C code. Instead, add a documentation-only "requirements.txt", which we can point Read the Docs to.
365f0dc to
c07c9ac
Compare
|
I made a private docs build to verify this solves the problem. |
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.
The documentation build uses docstrings from the code, and so it needs the code to be importable.
We already use a fake _ldap module for cases where the C compiler is not available, like on Read the Docs.
Another issue on Read the Docs is that the
pyasn1dependency needs to be installed. This can't be done automatically via setup.py install, as that would attempt to build C code.Instead, add a documentation-only "requirements.txt", which we can point Read the Docs to.