Analyze howto document

[voxelers]

Analyze howto document

[acs]

Let's start adding the basic doc. Right now we don't have a lot of doc:

https://mcthings.readthedocs.io/en/latest/

Let's start filling it using the guide at:

https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html

[acs]

Just follow the tutorial but do create the docstrings doc:

[docs](docs)$ sphinx-apidoc -o source/ ../mcthings

Nice jgb: https://github.com/chaoss/grimoirelab-perceval/blob/master/docs/howto_doc.rst

[acs]

Interesting reading with fix for automodule issue: https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/

This bite me also: readthedocs/readthedocs.org#2569 (comment)

[acs]

https://mcthings.readthedocs.io/en/latest/

Cool, we have doc now!

[acs]

But it does not include yet all the details about the modules ... researching the reason.

[acs]

Now it is working. You must configure the project as Python language project!

https://mcthings.readthedocs.io/en/latest/

All ready for having the doc published. In the future we will define carefully howto version it!

[acs]