New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Doc/requirements.txt for Read the Docs build #260

Merged
merged 1 commit into from Jan 30, 2019

Conversation

Projects
None yet
1 participant
@encukou
Copy link
Member

encukou commented Jan 30, 2019

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.

Add Doc/requirements.txt for Read the Docs build
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.
@encukou

This comment has been minimized.

Copy link
Member Author

encukou commented Jan 30, 2019

I made a private docs build to verify this solves the problem.
This is not a code change and it's needed to get documentation building.
I am using my admin powers to merge without review.

@encukou encukou merged commit 7fb02c0 into python-ldap:master Jan 30, 2019

3 of 4 checks passed

continuous-integration/travis-ci/push The Travis CI build is in progress
Details
codecov/patch Coverage not affected when comparing 2059c13...c07c9ac
Details
codecov/project 71.1% remains the same compared to 2059c13
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@encukou encukou deleted the encukou:doc-requirements branch Jan 30, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment