Update Sphinx Docs and Automated gh-pages deployment #45
Conversation
Started working on updating PyFFI docs Completetly regenerated the Sphinx docs and added some more features to it. Branched out the pyffi api documentation Todo: - Expand docs to make PyFFI easily understandable to others - Fix some errors in the code Maybe: - I might have to rewrite some code competently to make it compatible with autodoc!
# Conflicts: # tests/test_doctests.py
2 similar comments
Started working on updating PyFFI docs Completetly regenerated the Sphinx docs and added some more features to it. Branched out the pyffi api documentation Todo: - Expand docs to make PyFFI easily understandable to others - Fix some errors in the code Maybe: - I might have to rewrite some code competently to make it compatible with autodoc!
# Conflicts: # docs/index.rst
|
Is this supposed to happen when I rebase the branch? ... |
|
Okay, there is something funky going on with my computer... Can I close this and redo it? |
|
I can give feedback on your own branch and then we can squash to a singe commit when its ready as I have no idea why your getting duplicate commits. It will avoid automated builds being generated. |
1 similar comment
| @@ -29,6 +29,16 @@ script: | |||
| after_success: | |||
| - coveralls | |||
| - python setup.py sdist bdist_wheel | |||
There was a problem hiding this comment.
Why are you removing the sdist & bdist_wheel
There was a problem hiding this comment.
I didn't, that's how the yml works
| @@ -1,11 +1,24 @@ | |||
| PyFFI | |||
| ===== | |||
| .. image:: https://travis-ci.org/niftools/pyffi.png?branch=develop | |||
| .. image:: https://img.shields.io/travis/niftools/pyffi/develop.svg | |||
There was a problem hiding this comment.
How were these created, who controls them?
There was a problem hiding this comment.
https://shields.io is a website that provides high-quality metadata badges for open source projects.
| @@ -57,6 +57,7 @@ install: | |||
| - "set HOME=%APPVEYOR_BUILD_FOLDER%" | |||
| - "%PIP% install setuptools pip --upgrade" | |||
| - "%PIP% install check-manifest coveralls nose pytest pytest-cov twine wheel" | |||
There was a problem hiding this comment.
Any reason for not using the previous line?
| @@ -1,70 +0,0 @@ | |||
| # Makefile for Sphinx documentation | |||
There was a problem hiding this comment.
When reorganising folder structure, use git mv if not using an IDE with git integration.
This avoids the review bloating where it looks like you deleted the contents of files and created files.
There was a problem hiding this comment.
I did that with a new branch as I am doing everything all over again.
| 'pypi': 'PyFFI', | ||
| 'discord_id': 309117867398397952, | ||
| 'discord_invite': 'https://img.shields.io/discord/309117867398397952.svg', | ||
| 'rtd': 'tagnumelite-pyffi', |
There was a problem hiding this comment.
Remove reference to your local version.
| @@ -13,10 +13,10 @@ then | |||
| echo "PyFFI test release - documentation not included" > docs/index.html | |||
| else | |||
| rm -rf docs | |||
| pushd docs-sphinx | |||
| pushd docs | |||
| make html SPHINXBUILD=sphinx-build-3.2 | |||
There was a problem hiding this comment.
Is this still correct since you've bumped versions.
There was a problem hiding this comment.
I didn't bump versions though... also, makezip.bat and makezip.sh use epydoc. So I left that un touched in the new branch.
| @@ -1,13 +1,14 @@ | |||
| """ | |||
| :mod:`pyffi` --- Interfacing block structured files | |||
| =================================================== | |||
| PyFFI --- Interfacing block structured files | |||
There was a problem hiding this comment.
An experiment. I didn't do it this time.
| @@ -5,4 +5,5 @@ pdbpp | |||
| pyflakes | |||
| pytest | |||
| pytest-cov | |||
| sphinx | |||
| sphinx>=1.6.0 | |||
| niftools_sphinx_theme | |||
There was a problem hiding this comment.
Probably good to stick a version here also.
Where is this sourced from seeing as it has "niftools", its not one of our projects.
There was a problem hiding this comment.
It's a sphinx theme I created from copying your niftools.github.io repository so that all the documentation would look the same as the main website.
| license="BSD", | ||
| keywords="fileformat nif cgf binary interface stripify", | ||
| platforms=["any"], | ||
| description="Processing block structured binary files.", | ||
| classifiers=[_f for _f in classifiers.split("\n") if _f], | ||
| long_description=long_description, | ||
| url="https://github.com/niftools/pyffi", | ||
| download_url="https://github.com/niftools/pyffi/releases" | ||
| download_url="https://github.com/niftools/pyffi/releases", | ||
| install_requires=requirements |
There was a problem hiding this comment.
Should not use requirement-dev as the requirements - https://caremad.io/posts/2013/07/setup-vs-requirement/
| @@ -103,4 +103,4 @@ def test_nested_braces(self): | |||
|
|
|||
There was a problem hiding this comment.
Rebase issue by the looks of things.
There was a problem hiding this comment.
That's what caused the double commit problem and me closing this pull request.
|
Anyway, I am redoing this all over again as well as changing the way I am doing things. |
@niftools/pyffi-reviewer
Overview
Updates to the documentation's theme and tree. This should allow for more in-depth information as well building gh-pages as long as there is an access key assigned to Travis.
Fixes Known Issues
N/A
Documentation
I require information to update the docs.
Testing
N/A, shouldn't be needed
Manual
You are required to create a GitHub access key to allow Travis to push to gh-pages.
Automated
N/A
Additional Information
I require information to update the docs with.