[
https://issues.apache.org/jira/browse/TS-2803?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14000952#comment-14000952
]
ASF GitHub Bot commented on TS-2803:
------------------------------------
GitHub user jablko opened a pull request:
https://github.com/apache/trafficserver/pull/87
TS-2803: Use documentation strings extracted from source files in projec...
...t documentation
I rebased and added doxygen and python-lxml to contrib/manifests/debian.pp,
next to python-sphinx. None of the other manifests mentions Sphinx.
I updated doxygen.py to issue warnings if the Python lxml library isn't
installed but so far I haven't added anything to checkvers.py. If the library
is missing, warnings are issued and the extra strings are just omitted from the
built documentation.
I guess I'll have one or two tweaks to commit after we get a look at the
Read the Docs build log, but based on what I've read it will work.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/jablko/trafficserver TS-2803
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/trafficserver/pull/87.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #87
----
commit 7a97a8e935ed39be5d5b47e06191eaaf9567650a
Author: Jack Bates <[email protected]>
Date: 2014-05-13T16:51:53Z
TS-2803: Use documentation strings extracted from source files in project
documentation
----
> Use documentation strings extracted from source files in project documentation
> ------------------------------------------------------------------------------
>
> Key: TS-2803
> URL: https://issues.apache.org/jira/browse/TS-2803
> Project: Traffic Server
> Issue Type: Bug
> Components: Documentation
> Reporter: Jack Bates
> Assignee: James Peach
> Fix For: 5.0.0
>
>
> Add a Sphinx extension that can grab documentation strings that have been
> extracted from source files by Doxygen, translate them into reStructuredText,
> and then use them inside Sphinx documents.
--
This message was sent by Atlassian JIRA
(v6.2#6252)
