Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve/Clean sphinx related code #48

Merged
merged 1 commit into from
Nov 27, 2017

Conversation

TagnumElite
Copy link
Member

@niftools/pyffi-reviewer

Overview

Add some of the improvements mentioned in #46 that wasn't implemented before the merge.

  • Change BuildDocs from print into raise exception
    So that it fails the travis build when the docs aren't buildable
  • Tell coverage not to cover BuildDoc class
    The BuildDoc class isn't required to be documented.
  • Remove sphinx conf.py test code
  • Update sphinx conf.py paths

Fixes Known Issues

None

Documentation

No BuildDoc coverage

Testing

Nothing important changed, all code should be working fine.

Manual

python -m pip uninstall sphinx python setup.py build_docs

Automated

No new errors were created.

Additional Information

Please do not merge this request until I say so please. I wish to see if I can fix some sphinx build errors first.
Do tell me what you would like improved/fixed/remove!

- Change build_docs from print into raise exception
- Tell coverage not to cover BuildDoc class
- Remove sphinx conf.py test code
- Update sphinx conf.py paths
@coveralls
Copy link

coveralls commented Nov 26, 2017

Coverage Status

Coverage increased (+0.007%) to 58.38% when pulling 666290d on TagnumElite:clean_pyffi into 7f61cc2 on niftools:develop.

@neomonkeus neomonkeus self-assigned this Nov 27, 2017
@neomonkeus neomonkeus added this to the Version 2.2.4 milestone Nov 27, 2017
@neomonkeus neomonkeus merged commit db4d0a9 into niftools:develop Nov 27, 2017
@TagnumElite TagnumElite deleted the clean_pyffi branch November 27, 2017 21:02
@TagnumElite TagnumElite restored the clean_pyffi branch November 28, 2017 13:07
@neomonkeus neomonkeus added this to In progress in Pyffi Release Readiness Dec 13, 2017
@neomonkeus neomonkeus moved this from In progress to Done in Pyffi Release Readiness Apr 5, 2018
neomonkeus added a commit to neomonkeus/pyffi that referenced this pull request Nov 17, 2019
Previous HEAD position was f265c56 Merge pull request niftools#48 from Ghostwalker71/fix/extravectorflags
HEAD is now at d81d1f4 Merge pull request niftools#75 from jonwd7/develop
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

3 participants