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

Add a --parallel flag for build_docs #498

Merged
merged 12 commits into from
Nov 18, 2019
Merged

Conversation

astrofrog
Copy link
Member

@astrofrog astrofrog commented Nov 13, 2019

This does several things:

  • Adds a --parallel option for build_docs
  • Drops support for Python 3.5
  • Adds a requirement on sphinx-astropy 1.2 - this is a very recent release, but I think probably ok since this is mostly for package maintainers/developers who can easily update?
  • Requiring sphinx-astropy 1.2 also allows us to support only Sphinx 1.7 and above, so simplifies some of the logic here
  • Removed leftover references to auto-installing sphinx-astropy
  • Switch to Travis CI for Windows builds (I couldn't fix the AppVeyor one)

@astrofrog astrofrog requested a review from bsipocz November 13, 2019 09:49
@astrofrog astrofrog added the Docs label Nov 13, 2019
@astrofrog astrofrog added this to the v4.0 milestone Nov 13, 2019
@astrofrog
Copy link
Member Author

Trying to debug the failing CI...

…opy and switch to Travis CI for Windows builds. Also fix version comparison in build_docs.
@codecov
Copy link

codecov bot commented Nov 13, 2019

Codecov Report

Merging #498 into master will increase coverage by 0.58%.
The diff coverage is 57.14%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #498      +/-   ##
==========================================
+ Coverage   40.96%   41.54%   +0.58%     
==========================================
  Files          19       19              
  Lines        1665     1661       -4     
==========================================
+ Hits          682      690       +8     
+ Misses        983      971      -12
Impacted Files Coverage Δ
astropy_helpers/tests/test_setup_helpers.py 0% <0%> (ø) ⬆️
astropy_helpers/commands/build_sphinx.py 78.18% <72.72%> (+1.45%) ⬆️
astropy_helpers/setup_helpers.py 66.78% <0%> (+0.7%) ⬆️
astropy_helpers/utils.py 60.97% <0%> (+7.31%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a1b4e02...7cd8ca8. Read the comment docs.

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some comments @astrofrog, but nothing drastic

.travis.yml Outdated
@@ -23,41 +22,53 @@ env:
- PIP_DEPENDENCIES="codecov"
- EVENT_TYPE='push pull_request'
- DEBUG=True
- CONDA_CHANNELS="astropy"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what do we install from conda that we need from the astropy channel?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e.g. could just add this to the one build that conda installs sphinx-astropy rather than being a global setting (probably doesn't matter much, but I expect things might be slightly be faster using just the default channels)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

# Test conda's clang
- os: osx
env:
- PYTHON_VERSION=3.5
- PYTHON_VERSION=3.7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need python 3.8 builds, too

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can do that in a separate PR since that's well beyond the scope of this one :)

@@ -4,7 +4,9 @@ astropy-helpers Changelog
4.0 (unreleased)
------------------

- No changes yet.
- Changed minimum required Python version to 3.6. [#498]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would also mention the change in the minimum sphinx version

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

"""
# We've split out the Sphinx part of astropy-helpers into sphinx-astropy
# but we want it to be auto-installed seamlessly for anyone using
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably worth mentioning in the changelog that there is no more auto installing

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was actually done in #474 for 3.2 - I'm just removing leftover comments.

astropy_helpers/commands/build_sphinx.py Show resolved Hide resolved
@bsipocz bsipocz merged commit 7522a9f into astropy:master Nov 18, 2019
@bsipocz
Copy link
Member

bsipocz commented Nov 18, 2019

Thanks @astrofrog!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants