You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by "ASF subversion and git services (JIRA)" <ji...@apache.org> on 2015/03/12 15:34:38 UTC

[jira] [Commented] (DISPATCH-125) Convert documentation to rst, generate book and HTML man pages from sphinx.

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

ASF subversion and git services commented on DISPATCH-125:
----------------------------------------------------------

Commit 1666214 from [~aconway] in branch 'dispatch/branches/0.4'
[ https://svn.apache.org/r1666214 ]

DISPATCH-125: Convert documentation to rst, generate book and HTML man pages from sphinx.

Sphinx and RST are more complete & flexible documentation tools.

- Converted doc to RST (using pandoc)
- Generate HTML book and HTML man pages with sphinx
- Generating man pages with sphinx

NOTE: to install everything including documentation you need to do:

    make all
    make doc
    make install

Note that "make doc install" will not install the doc properly (the install runs
before building the docs)

> Convert documentation to rst, generate book and HTML man pages from sphinx.
> ---------------------------------------------------------------------------
>
>                 Key: DISPATCH-125
>                 URL: https://issues.apache.org/jira/browse/DISPATCH-125
>             Project: Qpid Dispatch
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.3
>            Reporter: Alan Conway
>            Assignee: Alan Conway
>             Fix For: 0.4
>
>
> Sphinx and RST are more complete & flexible documentation tools and appear to be more widely available in linux distros than pandoc.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@qpid.apache.org
For additional commands, e-mail: dev-help@qpid.apache.org