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

[DOC] Move documentation to gh-pages #1105

Closed
oesteban opened this issue May 4, 2018 · 9 comments
Closed

[DOC] Move documentation to gh-pages #1105

oesteban opened this issue May 4, 2018 · 9 comments
Labels

Comments

@oesteban
Copy link
Member

oesteban commented May 4, 2018

Building documentation in RTD generates a lot of noise. We could just submit the documentation built in circle, back to github (https://github.com/oesteban/ghpages-deploy-script).

As for the analytics: https://stackoverflow.com/questions/17207458/how-to-add-google-analytics-tracking-id-to-github-pages

@effigies
Copy link
Member

effigies commented May 4, 2018

One thing about RTD is the archiving of old versions of the docs. Would we be abandoning that?

@oesteban
Copy link
Member Author

oesteban commented May 4, 2018

I didn't think of that. Maybe we can just deploy to RTD but skip their automated build?

@effigies
Copy link
Member

effigies commented May 4, 2018

If we can do that, I'd be up for it.

@oesteban
Copy link
Member Author

oesteban commented May 4, 2018

Apparently we can't readthedocs/readthedocs.org#1083

@effigies
Copy link
Member

effigies commented May 5, 2018

Just looked through RTD settings. I believe the noise occurs because we produce PDFs along with our HTML docs, but RTD can't build the same version in parallel, so it errors and re-runs. I will note that the PDFs have some formatting issues (lots of blank pages, author list too long for the title page, and some chunks missing entirely). Do we think that anybody uses these, and that they're worth building?

@oesteban
Copy link
Member Author

oesteban commented May 5, 2018 via email

@effigies
Copy link
Member

effigies commented May 5, 2018

Okay, turned off. We'll see if that cuts down on the noise. I'll close this for now. Let's reopen if the emails keep coming.

@effigies effigies closed this as completed May 5, 2018
@oesteban
Copy link
Member Author

We are getting memory errors on readthedocs now. I think this is going to be unavoidable.

@oesteban oesteban reopened this Jul 31, 2018
@stale
Copy link

stale bot commented May 27, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label May 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants