commit c134d3eeddd5f1ae99c8b09fd63891c15f7cc3b9 Author: Isis Lovecruft isis@torproject.org Date: Mon Jul 20 21:23:30 2015 +0000
Tiny documentation fixes for how to use the Sphinx traclinks extension. --- bridgedb/parse/descriptors.py | 2 +- doc/sphinx/ext/traclinks.py | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/bridgedb/parse/descriptors.py b/bridgedb/parse/descriptors.py index 1b0108e..2986fd3 100644 --- a/bridgedb/parse/descriptors.py +++ b/bridgedb/parse/descriptors.py @@ -92,7 +92,7 @@ def parseNetworkStatusFile(filename, validate=True, skipAnnotations=True, descriptorClass=RouterStatusEntryV3): """Parse a file which contains an ``@type bridge-networkstatus`` document.
- See :trac:`#12254` for why networkstatus-bridges documents don't look + See :trac:`12254` for why networkstatus-bridges documents don't look anything like the networkstatus v2 documents that they are purported to look like. They are missing all headers, and the entire footer including authority signatures. diff --git a/doc/sphinx/ext/traclinks.py b/doc/sphinx/ext/traclinks.py index fd2d9b3..75abce4 100644 --- a/doc/sphinx/ext/traclinks.py +++ b/doc/sphinx/ext/traclinks.py @@ -3,13 +3,14 @@ RestructuredText interpreted text role that looks like this::
:trac:`trac_link_text`
-for example:: +For example::
- :trac:`#2015` + :trac:`2015`
-creates a link to ticket number 2015. +would create a link to ticket number #2015 (e.g. the link URI would be +https://bugs.torproject.org/2015).
-adapted from recipe here_. +Adapted from recipe here_.
.. _here: http://stackoverflow.com/a/2111327/13564 """