[tor-bugs] #29200 [UX]: Make more accessible Core Tor documentation
Tor Bug Tracker & Wiki
blackhole at torproject.org
Thu Feb 7 13:38:31 UTC 2019
#29200: Make more accessible Core Tor documentation
---------------------------+--------------------------
Reporter: juga | Owner: antonela
Type: defect | Status: new
Priority: Medium | Milestone:
Component: UX | Version:
Severity: Normal | Resolution:
Keywords: documentation | Actual Points:
Parent ID: | Points:
Reviewer: | Sponsor:
---------------------------+--------------------------
Comment (by juga):
Sphinx (http://www.sphinx-doc.org/en/stable/) is the tool to generate html
from markdown or restructured text and python docstrings.
https://readthedocs.org/ is a service that automatically publish the html
from the source documentation.
As ahf pointed out, https://breathe.readthedocs.io/en/latest/ can be used
to format doxygen documentation as sphinx html.
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/29200#comment:3>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
More information about the tor-bugs
mailing list