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

Package docs files for simple deployment #2033

Merged
merged 1 commit into from
Jul 29, 2016

Conversation

daspecster
Copy link
Contributor

  • Working towards cleaner packaging for releases.
  • Fixed a bug in the navigation.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jul 29, 2016
@dhermes
Copy link
Contributor

dhermes commented Jul 29, 2016

Does this break the standard Sphinx docs, e.g. tox -e docs-rtd?

@daspecster
Copy link
Contributor Author

I don't think so, however it looks like it's broken anyway.

AFAICT there are no overlapping directories.
tox -e docs-rtd's output directories are sphinx-build -W -b html -d docs/_build_rtd/doctrees docs docs/_build_rtd/html

However I do get this error when running tox -e docs-rtd

- gcloud.error_reporting.client
ERROR: InvocationError: '/Users/daspecster/Documents/google/gcloud-py/.tox/docs-rtd/bin/python /Users/daspecster/Documents/google/gcloud-py/scripts/verify_included_modules.py'

I'll fix this real quick an make another PR.

@dhermes
Copy link
Contributor

dhermes commented Jul 29, 2016

Does that mean tox -e docs is broken as well?

@daspecster
Copy link
Contributor Author

Oddly, tox -e docs seems to work.

@dhermes
Copy link
Contributor

dhermes commented Jul 29, 2016

That is odd

@daspecster
Copy link
Contributor Author

Ok, so I uninstalled gcloud from my venv and reinstalled it via python setup.py develop and now tox -e docs-rtd and tox -e docs are both working again.

@dhermes
Copy link
Contributor

dhermes commented Jul 29, 2016

tox should be isolated from your venv, that is the whole point of tox

@daspecster
Copy link
Contributor Author

Yeah, I'm really not sure what was going on at this point.

Maybe I had something funky going on and somehow it was picking up an old version of gcloud?

When your test commands execute they will execute with a PYTHONPATH setting that will lead Python to also import from the subdir below the directory where your tox.ini file resides.

@dhermes
Copy link
Contributor

dhermes commented Jul 29, 2016

This LGTM provided it doesn't break RTD. Can you check when the new build happens

https://readthedocs.org/projects/gcloud-python/builds/

and make sure

http://gcloud-python.readthedocs.io/en/latest/

looks fine?

(UPDATE: For the record, RTD's build can't use tox -e docs, I just wanted to make sure that nothing was out of place.)

@daspecster
Copy link
Contributor Author

Will do!

@daspecster daspecster merged commit bbf5053 into googleapis:master Jul 29, 2016
@daspecster daspecster deleted the docs-updates branch July 29, 2016 18:35
@daspecster
Copy link
Contributor Author

Looks like ReadTheDocs built successfully. Clicking around on the site works good.

https://readthedocs.org/projects/gcloud-python/builds/4249133/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants