search

niftools / pyffi

PyFFI is a Python library for processing block structured files.
http://www.niftools.org/pyffi
Other
47 stars 26 forks source link

Move Documentation, Pretty class names and auto-deployment #46

Closed TagnumElite closed 6 years ago

TagnumElite commented 6 years ago

@niftools/pyffi-reviewer

Overview

  1. Add GitHub Pages documentation deployment
  2. Move docs-sphinx to docs.
  3. Move pyffi*.rst to their respective folders
  4. Update README.rst and CONTRIBUTE.rst
  5. Add build_docs to setup.py
  6. Make PyFFI installable without sphinx
  7. Change setup.py classifiers to a list
  8. Add Missing Documentation Files
  9. Pretty class names of _MetaEnumBase, _MetaStuctBase and _MetaBitStuctBase
  10. Add Favicon/Logo to documenation
  11. Make _MetaEnumBase iterable and subscriptable
  12. Make _MetaEnumBase attributes snake case to be importable

Fixes Known Issues

None

Documentation

Add Sphinx Auto-Documentation:

Testing

Run command:

    cd docs
    make html
==or==
    python setup.py build_docs

Manual

You will need to set a github_token variable in your Travis project repository environment variables.

Automated

No tests were added or removed. No errors from py.test

Additional Information

The .travis.yml file will need to be updated to suite your repository needs.

coveralls commented 6 years ago

Coverage Status

Coverage decreased (-0.01%) to 58.373% when pulling 80ae40191766622795d36384fac66c020ac00719 on TagnumElite:sphinx into 82083af33f11702dd2adbb173c4fcdbcfffaa70d on niftools:develop.

coveralls commented 6 years ago

Coverage Status

Coverage decreased (-0.01%) to 58.373% when pulling 80ae40191766622795d36384fac66c020ac00719 on TagnumElite:sphinx into 82083af33f11702dd2adbb173c4fcdbcfffaa70d on niftools:develop.

coveralls commented 6 years ago

Coverage Status

Coverage decreased (-0.01%) to 58.373% when pulling 80ae40191766622795d36384fac66c020ac00719 on TagnumElite:sphinx into 82083af33f11702dd2adbb173c4fcdbcfffaa70d on niftools:develop.

neomonkeus commented 6 years ago

Going to take a look at this more in-depth today. Just took a quick peak at the coverage, bit surprised that there was a decrease. Can you take a look at whether this is needed any longer - https://coveralls.io/builds/14125327/source?filename=pyffi%2Futils%2F__init__.py#L47

neomonkeus commented 6 years ago

Solid work :+1: Will take a spin at it later.

psi29a commented 6 years ago

Agreed! :)

TagnumElite commented 6 years ago

@neomonkeus This is because I added a not so well documented BuildDoc command class that is used when sphinx is not installed. This stops python setup.py build_docs/install from throwing errors which could cause appveyor and/or travis from failing if they ever happen to fail to install sphinx. Plus users shouldn't need to install sphinx to use PyFFI

psi29a commented 6 years ago

It is done!