Skip to content
This repository has been archived by the owner on Nov 5, 2019. It is now read-only.

Making docs tox target fail on untracked changes. #260

Merged
merged 1 commit into from
Aug 13, 2015

Conversation

dhermes
Copy link
Contributor

@dhermes dhermes commented Aug 12, 2015

Checking if sphinx-apidoc generates new content and failing the script if the content is not checked in to version control.

Fixes #257.

@nathanielmanistaatgoogle I debated adding a tox target that would just generate the new content, but tox -e docs will still do this before failing, after which a user could then

$ git add docs/
$ tox -e docs  # This time it won't fail

Checking if sphinx-apidoc generates new content and failing
the script if the content is not checked in to version
control.
@dhermes
Copy link
Contributor Author

dhermes commented Aug 12, 2015

@nathanielmanistaatgoogle If you want to see it in action you can check out https://github.com/dhermes/oauth2client/tree/fake-change and run tox -e docs.

If you already have the code checked out locally (from google/oauth2client)

$ git remote add dhermes https://github.com/dhermes/oauth2client/
$ git fetch dhermes
$ git branch fake-change dhermes/fake-change
$ git checkout fake-change
$ tox -e docs

@nathanielmanistaatgoogle
Copy link
Contributor

(Merging; PyPy platform test failures are unrelated.)

nathanielmanistaatgoogle added a commit that referenced this pull request Aug 13, 2015
Make docs tox target fail on untracked changes.
@nathanielmanistaatgoogle nathanielmanistaatgoogle merged commit 3bd3fc5 into googleapis:master Aug 13, 2015
@dhermes dhermes deleted the fix-257 branch August 13, 2015 14:06
@dhermes dhermes mentioned this pull request Aug 26, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants