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

Revisiting the built documentation issue #18

Closed
MelindaShore opened this issue Jun 7, 2014 · 2 comments
Closed

Revisiting the built documentation issue #18

MelindaShore opened this issue Jun 7, 2014 · 2 comments

Comments

@MelindaShore
Copy link
Contributor

readthedocs.org assumes the presence of an html build directory under your sphinx documentation, and since we removed ours (issue #15) our readthedocs.org documentation has disappeared. I would rather hang onto the documentation and clutter up the repo than be pristine and not be able to have our documentation automatically updated. readthedocs.org is pretty much the canonical location for Python packages and other stuff documented with sphinix, so clearly a lot of people are checking doc build directories into git.

What say you all?

@ngoyal
Copy link
Contributor

ngoyal commented Jun 7, 2014

I'd be hesitant to add _build. Other python libs (pymongo and flask were the two I checked) don't seem to have this in their repo. Is there some configuration w/ readthedocs that might have been overlooked?

@MelindaShore
Copy link
Contributor Author

Turns out that there's a github service (under the webhooks and services panel in the setting menu) that automatically builds sphinx-formated documentation for readthedocs.org without dropping files into the repo. So, we're back. Thanks to Chris for the pointer.

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

2 participants