Sphinx documentation

[Tom Enos]

First draft (and first attempt at using sphinx) 

[Todd Giles]

Nice - if this is simple enough to automate would be nice to publish it to lightshowpi.org...

On Tue, Jun 23, 2015 at 6:43 PM Tom Enos <tom....@overclocked.net> wrote:

First draft (and first attempt at using sphinx) 

--
http://www.lightshowpi.org/
---
You received this message because you are subscribed to the Google Groups "LightShow Pi Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to lightshowpi-d...@googlegroups.com.
To post to this group, send email to lightsh...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/lightshowpi-dev/26c7b43c-6799-4b40-a4d5-63624972be83%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Tom Enos]

I wouldn't say it was simple, but also it is not that difficult.  It takes a little time to get use to the syntax. 

I have attached a copy of the source.  Just let me know what you want to do and I will make it happen.

Also remember that is a first draft and I already had part of the work done.

I remember you asking about the way I was writing the docstrings

"""A function


:param x: some variable
:type x: string

:return: something
:rtype: list
"""

It turns out that is what sphinx likes.  So the autodoc part was mostly done.

The rest is just the learning curve for making things look the way we want.

Sphinx has theme support also, I just used a theme that I felt was easy on the eyes.  Here are a few that come with it http://sphinx-doc.org/theming.html#builtin-themes (one of them looks just like the python docs pages)

Plus we could make our own theme and layout.  Instructions are on the same page.