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

fix readthedocs build #16

Closed
cehbrecht opened this issue Mar 8, 2018 · 4 comments · Fixed by #39
Closed

fix readthedocs build #16

cehbrecht opened this issue Mar 8, 2018 · 4 comments · Fixed by #39
Assignees
Milestone

Comments

@cehbrecht
Copy link
Member

... it was using requirements/rtd.txt.

@cehbrecht cehbrecht added the bug label Mar 8, 2018
@cehbrecht cehbrecht added this to the 0.7.0 milestone Mar 8, 2018
@cehbrecht cehbrecht self-assigned this Mar 8, 2018
@huard
Copy link
Contributor

huard commented Mar 8, 2018

Using the autoprocess directive makes building the docs on rtd more complicated, as we need to install the package dependencies.

@cehbrecht
Copy link
Member Author

Currently I can't get this to work on ReadTheDocs. It is possible to setup a virtualenv on ReadTheDocs but I don't have the latest pywps on pypi. It will also fail if we include more then pure Python dependencies.

@huard Is it possible to make the pywps sphinx extension like the sphinx autoapi? autoapi is using a static code parser and does not need "Python imports", dependencies.

@cehbrecht cehbrecht modified the milestones: 0.8.0, 0.9.0 Jun 6, 2018
@huard
Copy link
Contributor

huard commented Jun 6, 2018

Well, I have no idea how static code parsers work. If it's just scraping the docstring, then no, it's not possible. If there is a fancy mechanism that understands subclasses, attributes, then yes, it might be possible.

Also, there does not seem to be any hooks within the autoapi extension to write domain specific parsers, so we're talking about first making change to autoapi itself, then writing our own parser on top of it.

Are you sure about the pure python dependencies ? If we require numpy, surely it can install it through pip.

Can we fix this by clearly separating import dependencies and run dependencies (as in ansible)?

Travis is able to import the code, could we get it to also build the docs and push them to githubio ?

@cehbrecht
Copy link
Member Author

@huard I got it working with having a separate rtd.txt environment for readthedocs. It pulls pywps from github:
https://emu.readthedocs.io/en/latest/processes.html

I have moved the discussion to pywps:
geopython/pywps#343

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

Successfully merging a pull request may close this issue.

2 participants