Investigate integration of formulas into docstrings

[fedorov]

also see

https://pythonhosted.org/an_example_pypi_project/sphinx.html

[fedorov]

and http://www.sphinx-doc.org/en/stable/ext/math.html

references courtesy @jcfr !

[naucoin]

Related to Issue #3 ?

[fedorov]

useful tutorial: http://gisellezeno.com/tutorials/sphinx-for-python-documentation.html

[fedorov]

Sample screenshots of the look and features of the sphinx generated html pages

Top-level page (different themes are available, I liked this one the most)

Full text search capability:

Documentation for the specific function, search result highlight:

Source code for the specific function is cross-linked:

[fedorov]

wiki page https://github.com/Radiomics/pyradiomics/wiki/Documentation-infrastructure

[jcfr]

Nice.

Using the sphinx-quickstart is also helpful to generate the initial skeleton. See http://read-the-docs.readthedocs.io/en/latest/getting_started.html

[pieper]

+1

On Tue, Jun 28, 2016 at 2:52 PM, Jean-Christophe Fillion-Robin < notifications@github.com> wrote:

Nice.

Using the sphinx-quickstart is also helpful to generate the initial skeleton. See http://read-the-docs.readthedocs.io/en/latest/getting_started.html

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/Radiomics/pyradiomics/issues/53#issuecomment-229146583, or mute the thread https://github.com/notifications/unsubscribe/AAHsfZujVtKTxnc0nPBSScsFAdhqNbEzks5qQW2GgaJpZM4IXNzR .

[fedorov]

Using the sphinx-quickstart is also helpful to generate the initial skeleton.

yes, that is what I did. The wiki I references has a link to this guide http://gisellezeno.com/tutorials/sphinx-for-python-documentation.html, which uses quickstart, and I didn't duplicate the steps in that guide in the wiki.

[pieper]

Looks great!

[jcfr]

@fedorov Nice. Formula looks great too. Let me know when you have a PR ready for review.

[fedorov]

Resolved by #74