ACS-Community / ACS

Official ACS community fork
MIT License
28 stars 26 forks source link

Standardization of documentation format #8

Closed atejeda closed 8 years ago

atejeda commented 10 years ago

What I propose is to "migrate" all the current documentation to a same format, in this case as a markdown syntax which is readable by Github, this can be archived in a different repo e.g.: ACS/Documentation and added as a submodule or, migrated to Wiki Github pages. If is feasible, on top of this, review it (specially the tutorials).

jantogni commented 10 years ago

I suggest to use Sphinx as documentation tool. Sphinx use rst MarkDown also supported by github. I will create a first iteration and a step-by-step tutorial.

[1] http://sphinx-doc.org/

marco-buttu commented 10 years ago

I agree for restructuredtext and Sphinx. It is also possible to create on github webhooks to readthedoc

jantogni commented 8 years ago

@javarias decided that the future documentation will be written in reStructuredText, and will be placed at ACS/Documentation.

To migrate the current documentation (ACS/Documentation) to reStructuredText will be not part of the millestione 1 nor 2.