Migration to ReadTheDocs.org

[marmotz]

Migration in progress.

You can see the result on http://atoum.readthedocs.org

TODO

• [x] translate from skriv to reST
• [x] configure ReadTheDocs for automatic html build for fr and en
• [x] fix the pdf build (it doesn't work for now)
• [ ] create a custom html template (maybe later)
• [x] configure ReadTheDocs to be accessible by docs.atoum.org

[jubianchi]

:+1:

[marmotz]

All skriv files was translated to reST and ReadTheDocs was configured to build automatically docs for french (http://atoum.readthedocs.org) and english (http://atoum-en.readthedocs.org).

[marmotz]

PDF builds works now. A bug on ReadTheDocs was fixed by RTD team and now, our doc is accessible by http://atoum.readthedocs.org/fr (automatically redirected from http://atoum.readthedocs.org) and http://atoum.readthedocs.org/en

[marmotz]

• Do we need a custom template for our readthedocs documentation ?
• Do you want a http://docs.atoum.org or a http://atoum.readthedocs.org documentation ?

/cc @atoum/docs (no idea who is in this group)

[Hywan]

@marmotz Link to the bug?

[marmotz]

@Hywan https://github.com/rtfd/readthedocs.org/issues/1058

[jubianchi]

Do we need a custom template for our readthedocs documentation ?

For now, I think the content is the most important part we'll see later if making a custom template is needed. Thoughts ?

Do you want a http://docs.atoum.org or a http://atoum.readthedocs.org documentation ?

:+1: for http://docs.atoum.org

[marmotz]

so @mageekguy you should follow this instructions: https://docs.readthedocs.org/en/latest/alternate_domains.html#cname-support :)

[mageekguy]

Job done. FTR, i think that it's silly to trash all works done on the skriv version, and do not use our server to controlate documentation generation and publication, but, fine, you're the doc master, and maybe using readthedocs can help to improve the documentation with other contributors ;).

[marmotz]

Thank you @mageekguy ! It's working ! Look at http://docs.atoum.org :) \o/

Yes, I think a standard documentation generator and hoster with facilities to edit documentation is a good solution to have a good documentation.

[marmotz]

Thank you all for this migration ! And now ! We are going to improve documentation content !

[mageekguy]

It's working ! Look at http://docs.atoum.org :) \o/ <= Sure, if I say "Job done" ;) And thanks to YOU for your job.