libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Quentin Pradet (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LIBCLOUD-301) Consider switching documentation from custom Markdown to Sphinx + ReST
Date Wed, 28 Dec 2016 05:56:58 GMT

    [ https://issues.apache.org/jira/browse/LIBCLOUD-301?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15782145#comment-15782145
] 

Quentin Pradet commented on LIBCLOUD-301:
-----------------------------------------

I think it's safe to close this issue.

> 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 was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message