Set up initial Sphinx documentation build #3

Open
wants to merge 2 commits into
from

Projects

None yet

2 participants

@akkana
akkana commented Jan 8, 2017

This creates a Makefile and the necessary files for basic module documentation in Sphinx, plus a .gitignore for the built files and a few minor changes to the README. Are there documentation standards or themes/styles that we should be adhering to? The main matplotlib sphinx doc doesn't set a theme.

@akkana
akkana commented Jan 8, 2017

The setup.py change (comment out install_requires=['matplotlib']) shouldn't be part of this pull request. I do find I need it in order to use mpl_finance, but that's unrelated to the documentation issue and not everyone will need it (the matplotlib currently on pypi has a fatal bug on 32-bit Linux and maybe also on Windows)..

Should I make a new pull request with that part removed?

@efiring
Member
efiring commented Jan 8, 2017

No need for a new PR. You can just add a commit to the present PR by pushing it to your branch. If you want, you can use git rebase -i to squash the commits and then force-push, but this is not required.

@akkana akkana requested a review from efiring Jan 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment