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

add doc build make targets for nightly build #2106

Closed
wants to merge 1 commit into from

Conversation

agramfort
Copy link
Member

@Eric89GXL feel free to take over. It does not work yet.

Once this works it means we update the website with

cd mne-python
make build-doc-dev
cd ../mne-tools.github.io
make pull
make copy-dev
make push

@larsoner
Copy link
Member

What doesn't work, the xvfb-run command?

@agramfort
Copy link
Member Author

not sure.

does it work for you?

I tried on our common machine and got:

DISPLAY=:1 xvfb-run -f /tmp/xauthority-mne-python-doc --auto-servernum -s
"-screen 0 1280x1024x24 -noreset" make html_dev
make: *** [build-doc-dev] Error 1

@larsoner
Copy link
Member

I have never tried to use xvfb-run, I might be able to look today

@larsoner
Copy link
Member

Docs built, go ahead and do make pull && make copy-dev && make push. I can't pull or push because those directories have you as the git login.

We should also add an option to the doc building that makes it so that any errors it occurs actually stops the build. As it stands, I can't tell if the build completed successfully or not (remotely) without a push.

@agramfort
Copy link
Member Author

agramfort commented May 17, 2015 via email

@larsoner
Copy link
Member

@agramfort can you push the doc-building commit to this PR that contains the code I added plus anything else you tweaked since then?

@larsoner
Copy link
Member

@agramfort the API reference is borked:

http://mne-tools.github.io/dev/python_reference.html

@larsoner
Copy link
Member

The builds are fine on my Ubuntu system (system python + custom builds) but I have the same issue on Windows, so this is probably a problem with conda since your build system also uses that

@agramfort
Copy link
Member Author

agramfort commented May 19, 2015 via email

@larsoner
Copy link
Member

I don't think so, I'll try updating and see if it breaks

@larsoner
Copy link
Member

installing latest master also broke it for me, I'll see if some older version works

@larsoner
Copy link
Member

at least d3615d does, going to bisect and open a Sphinx issue

@larsoner
Copy link
Member

@agramfort you can:

git clone git://github.com/sphinx-doc/sphinx.git
cd sphinx
git checkout b9fe829
python setup.py develop

And that should give you something that will actually build our docs for now. See: sphinx-doc/sphinx#1891

@larsoner
Copy link
Member

PR sent:

sphinx-doc/sphinx#1892

@larsoner
Copy link
Member

@agramfort if you want, you can set up your build bot to use my branch for now, and you should be good to go. If you install with python setup.py develop then when it gets merged upstream you can just switch and pull.

@agramfort
Copy link
Member Author

agramfort commented May 19, 2015 via email

@larsoner
Copy link
Member

ping @agramfort please push your changes on your build system to this PR. it will need a rebase now BTW

@larsoner
Copy link
Member

Oh never mind, it looks like you've pushed them to master already. closing

@larsoner larsoner closed this May 22, 2015
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

Successfully merging this pull request may close these issues.

2 participants