I would love to hear other people take on this.

I think it's a step in the right direction and we should do it (reasons are
already listed in the ticket description). It also aligns up with a site
re-design / revamp which should be coming up in te near future.

---------- Forwarded message ----------
From: Tomaz Muraus (JIRA) <[email protected]>
Date: Fri, Mar 1, 2013 at 2:29 PM
Subject: [dev] [jira] [Created] (LIBCLOUD-301) Consider switching
documentation from custom Markdown to Sphinx + ReST
To: [email protected]


Tomaz Muraus created LIBCLOUD-301:
-------------------------------------

             Summary: Consider switching documentation from custom Markdown
to Sphinx + ReST
                 Key: LIBCLOUD-301
                 URL: https://issues.apache.org/jira/browse/LIBCLOUD-301
             Project: Libcloud
          Issue Type: Task
          Components: Documentation, Website
            Reporter: Tomaz Muraus


Consider moving documentation (http://libcloud.apache.org/docs/) to Sphinx.

Reasons:

- It's more idomatic / in Python world Sphinx is the standard
- We can also host it on readthedocs which is turning out to become a
defacto standard for hosting docs for Python libraries

Downsides:

- Currently docs are constitent with other website content and use
Markdown. For Sphinx we would need to use ReST.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA
administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Reply via email to