[next release] list of repos using doctr to PR fixes to

[gforsyth]

As of 1.5.0, the --gh-pages-docs flag is deprecated in favor of a required command line argument (doctr deploy deploy_dir). Several repos need to be updated.

Following the merge and release of #157

The list of repos I have using doctr (searching for doctr and filtering for YAML files) is:

• conda
  • merged
• sympy
  • merged
• xonsh (I can fix this)
  • merged
• pygbe (I can fix this)
  • merged
• essential_skills_RRC (I can fix this)
  • merged
• [x] https://github.com/pydata/pandas-design (although it says deprecated in the repo description)
• https://github.com/Carreau/warn
  • merged
• https://github.com/pyoceans/sea-py
  • merged
• https://github.com/maxpoint/spylon
  • merged
• https://github.com/danielballan/photomosaic
  • merged
• https://github.com/ergs/TWoFCS
  • merged
• https://github.com/pystitch/stitch not using doctr just installing it
• https://github.com/ergs/rg-db-twofcs
  • merged
• https://github.com/python-visualization/folium
  • merged
• https://github.com/sea-mat/sea-mat
  • merged
• https://github.com/bryanwweber/UConnRCMPy (pinged)
  • merged
• https://github.com/bryanwweber/thermostate (pinged)
  • merged
• [ ] setting up automatic publication of docs to github pages gallantlab/pycortex#205 (not yet merged) (pinged)
• https://github.com/juoceano/lecture_figures
  • merged
• https://github.com/Alsheh/tmp sympy fork
• https://github.com/antepsis/anteplahmacun sympy fork

[bryanwweber]

Hi! I'm the @bryanwweber that's using Doctr for my two repositories (and I'm setting up a third right now). What do I need to do here?

[asmeurer]

Nothing until we do a release, but we are deprecating the --gh-pages-docs flag of doctr deploy, and replacing it with a requirement argument (like doctr deploy .). Once we do a release we want to make sure all these repos are updated so that the change will have minimal impact once we remove the flag entirely.

[bryanwweber]

OK got it. I'll watch for the release and update accordingly. Thanks!

[gforsyth]

Hey @bryanwweber -- the latest doctr has been released, so you should change your doctr deploy lines to just treat the deploy directory as a required argument.
I'm happy to PR that in if you'd like.

[asmeurer]

Fixing SymPy at sympy/sympy#12339

[gforsyth]

Don't. Critical bug

[gforsyth]

Something in the checks to only push from the master branch isn't working

[gforsyth]

The push travis run will push the docs

[asmeurer]

OK, will hold off.

[Carreau]

Something in the checks to only push from the master branch isn't working

That might be in interference with the thing I did with branch whitelists.
I'll dig into it as well.

[gforsyth]

I think I found it -- this line (https://github.com/drdoctr/doctr/blob/master/doctr/travis.py#L166)
if any([re.compile(x).match(TRAVIS_BRANCH) for x in branch_whitelist]):
should be
if not any([re.compile(x).match(TRAVIS_BRANCH) for x in branch_whitelist]):
since we set canpush=False inside of that conditional. So instead we're allowing pushes from any branch except for master or anything in the whitelist

[Carreau]

Agreed, should we change if branch_whitelist is None to if not branch_whitelist, that won't behave the same if branch_whitelist is set to empty set or empty list.

[gforsyth]

ooh, yeah. good point. I'll put that in, too.