-
Notifications
You must be signed in to change notification settings - Fork 27
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
readthedocs page with auto-generated API documentation #16
Comments
I have set up https://elektronn3.readthedocs.io/ with a webhook to build and update docs on this page, but the build pipeline fails due to memory limitations: elektronn3/docs/sphinx-requirements.txt Lines 3 to 4 in 91c0b14
but apparently this is not enough. I haven't had success with mocking expensive requirements during documentation builds yet, but theoretically this should be a solution. Related: readthedocs/readthedocs.org#1767 |
My attempt at using a conda-based documentation build setup in the rtd-test branch fails due to a different issue: Sphinx >=1.7.1 has a bug that makes the build fail with the following message:
This does not happen when using sphinx 1.7.0 or earlier. I tried to fix this by pinning sphinx to 1.7.0 in the builder, but there is a second issue: Sphinx version pinning is currently ignored by readthedocs. We will probably have to wait until readthedocs/readthedocs.org#3829 is resolved. Also related: readthedocs/readthedocs.org#3769. |
After merging #24, there is a new kind of error in the rtd builder: https://readthedocs.org/projects/elektronn3/builds/7500776/ :( |
Once #15 is resolved, we should create a page on https://readthedocs.io to host elektronn3 documentation, similar to https://elektronn2.readthedocs.io/en/latest/. See ELEKTRONN/ELEKTRONN2#1 for an example of the initial readthedocs set-up.
The text was updated successfully, but these errors were encountered: