Skip to content

ensure docs build properly on readthedocs #2713

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

Closed
satra opened this issue Oct 7, 2018 · 2 comments
Closed

ensure docs build properly on readthedocs #2713

satra opened this issue Oct 7, 2018 · 2 comments
Milestone

Comments

@satra
Copy link
Member

satra commented Oct 7, 2018

nipype on readthedocs has not been building properly, since release 1.1.1:

https://readthedocs.org/projects/nipype/builds/7835987/

we should try to ensure that our own doc build returns appropriate errors on circle if they fail, which i thought it did. we should resolve what it is between our tests and readthedocs is altering the failure mode.

according to the error above it seems something about matplotlib sphinx extension

@satra
Copy link
Member Author

satra commented Oct 7, 2018

this extension exists at least in matplotlib release 2.2.2, which is available inside the nipype/nipype:py36 docker container.

so this is likely some setting in/for readthedocs that's causing issues.

@miykael
Copy link
Collaborator

miykael commented Oct 9, 2018

I tried to build the docs locally and got an error concerning matplotlib.sphinxext.only_directives. The easy solution was to just remove/comment this dependency in the conf.py file (here). But I'm not sure if it will lead to other errors down the line (or for what this extension is actually needed).

@mgxd mgxd removed their assignment Oct 11, 2018
@effigies effigies added this to the 1.1.4 milestone Oct 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants