Skip to content
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

Closed
mdraw opened this issue Apr 6, 2018 · 3 comments
Closed

readthedocs page with auto-generated API documentation #16

mdraw opened this issue Apr 6, 2018 · 3 comments

Comments

@mdraw
Copy link
Member

mdraw commented Apr 6, 2018

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.

@mdraw
Copy link
Member Author

mdraw commented May 25, 2018

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:
image
This is probably related to the large doc requirements like PyTorch. I already tried slimming down those requirements by using CPU-only wheels of PyTorch in

# Small CPU-only package, because PyPI package is ~ 500 MiB:
http://download.pytorch.org/whl/cpu/torch-0.4.0-cp36-cp36m-linux_x86_64.whl

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

@mdraw
Copy link
Member Author

mdraw commented Jun 10, 2018

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:

sphinx-build: error: argument -d/--maxdepth: invalid int value: '_build/doctrees-readthedocs'

This does not happen when using sphinx 1.7.0 or earlier.
(The same issue happens in ELEKTRONN2 currently. That's the reason why ELEKTRONN2 docs are out of date.)

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.

@mdraw
Copy link
Member Author

mdraw commented Jul 17, 2018

After merging #24, there is a new kind of error in the rtd builder: https://readthedocs.org/projects/elektronn3/builds/7500776/ :(
Let's hope that this is just a temporary server issue. The automatic online build was successful in a private area of the website, so I have no idea what else could be wrong.

@mdraw mdraw closed this as completed in 9748bae Jul 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant