improvements to project documentation

QuantEcon / sphinxcontrib-jupyter

A Sphinx Extension for Generating Jupyter Notebooks

BSD 3-Clause "New" or "Revised" License

76 stars 23 forks source link

improvements to project documentation #10

Closed mmcky closed 6 years ago

mmcky commented 6 years ago

This PR adds various improvements to the projects documentation.

jlperla commented 6 years ago

For #21 it would be useful to have the minimal set of files required (instead of just the documentation) for people to test out (including the conf.py etc.) Maybe just your basic regression test.

mmcky commented 6 years ago

Thanks @jlperla. I agree. A set of files (similar to those formed after sphinx-quickstart with the additional config) is a good idea. I will either add them to this repo under example or a separate repo sphinxcontrib-jupyter.example

jlperla commented 6 years ago

A separate repo is a great idea. Then maybe after getting the initial files updated you can put into that any tricks you have for getting CI working? Also, it was unclear to me how you are doing regression tests of the source-code, but I was pretty sure you were. That would be an excellent addition down the road (is it like doctest strings, for example?)

mmcky commented 6 years ago

[x] setup a minimum example sphinx setup in sphinxcontrib-jupyter.minimal

Once this is up and running this issue can be closed.