Skip to content

Update sphinx req to 1.7 and add version "policy" - #88

Merged
astrofrog merged 7 commits into
astropy:masterfrom
eteq:add-version-policy
Aug 13, 2019
Merged

astrofrog merged 7 commits into
astropy:masterfrom
eteq:add-version-policy

Conversation

@eteq

@eteq eteq commented Aug 12, 2019

Copy link
Copy Markdown
Member

This closes #85 by updating the sphinx dependecy to 1.7 as discussed further in that issue.

One thing I realized I wasn't sure about: when I dropped all the older tox environments, there was nothing left for py2.7, so I added one back in that does py2.7 and sphinx 1.7, which seems sensible. But I'm not 100% sure that one will work, so @astrofrog you might want to check that.

@eteq eteq changed the title Add version policy Update sphinx req to 1.7 and add version "policy" Aug 12, 2019
@eteq
eteq requested a review from astrofrog August 12, 2019 15:50
@codecov

codecov Bot commented Aug 12, 2019 •

Copy link
Copy Markdown

Codecov Report

Merging #88 into master will decrease coverage by 0.44%.
The diff coverage is 82.6%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #88      +/-   ##
==========================================
- Coverage    87.6%   87.15%   -0.45%     
==========================================
  Files           5        5              
  Lines         734      693      -41     
==========================================
- Hits          643      604      -39     
+ Misses         91       89       -2
Impacted Files Coverage Δ
sphinx_automodapi/utils.py 88.59% <100%> (-0.3%) ⬇️
sphinx_automodapi/automodapi.py 91.13% <100%> (-0.17%) ⬇️
sphinx_automodapi/automodsumm.py 85.75% <72.72%> (-0.62%) ⬇️
sphinx_automodapi/autodoc_enhancements.py 96.29% <83.33%> (+2.67%) ⬆️

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 9f0b05c...961fa48. Read the comment docs.

@astrofrog

astrofrog commented Aug 12, 2019 •

Copy link
Copy Markdown
Member

Python 2.7 with Sphinx 1.7 seems sensible! I've added a commit removing all the compatibility code we no longer need.

Comment thread sphinx_automodapi/automodsumm.py Outdated
if [clsonly, funconly, varonly].count(True) > 1:
self.warning('more than one of functions-only, classes-only, '
self.warn('more than one of functions-only, classes-only, '
'or variables-only defined. Ignoring.')

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

indent

from . import cython_testpackage # noqa

__all__ = ['build_main', 'write_conf', 'run_sphinx_in_tmpdir']
__all__ = ['write_conf', 'run_sphinx_in_tmpdir']

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is that OK to remove this from the namespace without a warning? I suppose yes as explicit imports still work.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I only added this in that namespace in my last PR

Comment thread tox.ini
sphinx16: sphinx==1.6.7
sphinx17: sphinx==1.7.9
sphinx18: sphinx==1.8.5
sphinx20: sphinx==2.0.1

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@astrofrog - unrelated to this PR, but why do we pin the version so precisely? This case no newer bugfix releases get tested (surely, it's only relevant for the latest release). What about setting sphinx==2.1.* instead? (I couldn't comment on the next line).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oh, does * work for pip?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

yes, it does, we do that in ci-helpers, too :)

@eteq eteq Aug 12, 2019 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I didn't want to do this in the commits I just pushed up since I'm not sure I fully understand the syntax here. So I'd say this could be a follow-on separate PR?

Comment thread sphinx_automodapi/autodoc_enhancements.py
@bsipocz

bsipocz commented Aug 12, 2019

Copy link
Copy Markdown
Member

Please do add a changelog entry, too.

@eteq

eteq commented Aug 12, 2019 •

Copy link
Copy Markdown
Member Author

OK, I think I addressed @bsipocz's suggetions (although I deferred 1 and ignored another - see comments above).

@astrofrog
astrofrog merged commit 3acbb6e into astropy:master Aug 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Decide on policy for supporting Sphinx versions

3 participants