doctr icon indicating copy to clipboard operation
doctr copied to clipboard

DOCS: Document best-practices for making doctr run only in one build

Open choldgraf opened this issue 8 years ago • 4 comments

E.g., with after_success only in python == 3.6 builds.

choldgraf avatar Jul 03 '17 16:07 choldgraf

Needs to be in script. after_success doesn’t cause the build to fail (there’s a note about this in the readme).

asmeurer avatar Jul 03 '17 18:07 asmeurer

gotcha, so then just check for the python version w/in script and add the doctr code after that?

On Mon, Jul 3, 2017 at 1:51 PM Aaron Meurer [email protected] wrote:

Needs to be in script. after_success doesn’t cause the build to fail (there’s a note about this in the readme).

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/drdoctr/doctr/issues/208#issuecomment-312713473, or mute the thread https://github.com/notifications/unsubscribe-auth/ABwSHaaojpsTx9VoTIS0mF60idj_22urks5sKThAgaJpZM4OMf_0 .

choldgraf avatar Jul 03 '17 18:07 choldgraf

Or check whatever environment variable you have your docs build set to.

asmeurer avatar Jul 03 '17 18:07 asmeurer

I'm using this in my code

script:
  # if any line in this section fails, build fails
  - set -e

  # build and run unit tests
  ...
  # build and deploy docs only for one python version and only for changes to master
  - if [[ $TRAVIS_PYTHON_VERSION == 3.6 ]]; then
       pip install doctr;
       make doc;
       doctr deploy . --built-docs doc/_build/;
    fi

fredRos avatar Sep 26 '17 07:09 fredRos