Basic Sphinx documentation

[einarf]

It would be nice to have basic sphinx documentation. Should be simple enough with autodoc + adding a simple guide of some sort. It can really help to bring more people to the project.

It's also quick to set up auto build on commits to for example readthedocs.

[greenmoss]

What do you think about something like https://readthedocs.org ?

EDIT: they start off with sphinx, so... reading that now 😄

[einarf]

I use readthedocs for a few projects. works great.

[greenmoss]

I put the beginning up on branch "docs":

https://github.com/greenmoss/PyWavefront/tree/docs

Following instructions from https://docs.readthedocs.io/en/latest/getting_started.html

The basics work:

[greenmoss]

So I'm now thinking about:

• What do we move from the README into here?
• Auto-adding docs based on comments in code

EDIT I see it's possible to just wholesale include everything. So the answer is "YES"

[einarf]

I would keep the readme and docs separate because the readme is only really supposed to be an intro to the project. It will in most cases contain things we don't want in the docs.