[tor-commits] [stem/master] Sphinx fixes

atagar at torproject.org atagar at torproject.org
Thu May 14 23:31:54 UTC 2020


commit c84b5c8fc34ed107bc5b3ee1b8d8e1b8783243e5
Author: Damian Johnson <atagar at torproject.org>
Date:   Mon May 11 15:26:37 2020 -0700

    Sphinx fixes
    
    Just correcting a few minor sphinx warnings...
    
      /home/atagar/Desktop/stem/docs/download.rst:165: WARNING: Inline interpreted text or phrase reference start-string without end-string.
      /home/atagar/Desktop/stem/docs/tutorials/east_of_the_sun.rst:65: WARNING: Literal block ends without a blank line; unexpected unindent.
      /home/atagar/Desktop/stem/docs/tutorials/mirror_mirror_on_the_wall.rst:2: WARNING: Duplicate explicit target name: "benchmark script".
      /home/atagar/Desktop/stem/docs/tutorials/mirror_mirror_on_the_wall.rst:2: WARNING: Duplicate explicit target name: "benchmark script".
---
 docs/download.rst                            | 2 +-
 docs/tutorials/east_of_the_sun.rst           | 1 +
 docs/tutorials/mirror_mirror_on_the_wall.rst | 6 +++---
 3 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/docs/download.rst b/docs/download.rst
index dcf7c7ad..ae2f4fb3 100644
--- a/docs/download.rst
+++ b/docs/download.rst
@@ -162,7 +162,7 @@ Download
      - .. image:: /_static/label/archlinux.png
           :target: https://www.archlinux.org/packages/community/any/python-stem/
 
-       Package by Sjon for `Arch Linux...
+       Package by Sjon for `Arch Linux <https://www.archlinux.org/>`_...
 
        ::
 
diff --git a/docs/tutorials/east_of_the_sun.rst b/docs/tutorials/east_of_the_sun.rst
index 4303170f..5b386e0e 100644
--- a/docs/tutorials/east_of_the_sun.rst
+++ b/docs/tutorials/east_of_the_sun.rst
@@ -62,6 +62,7 @@ that <../api/util/system.html#stem.util.system.DaemonTask>`_.
 
   % python fibonacci_multiprocessing.py
   took 6.2 seconds
+
 .. _connection-resolution:
 
 Connection Resolution
diff --git a/docs/tutorials/mirror_mirror_on_the_wall.rst b/docs/tutorials/mirror_mirror_on_the_wall.rst
index 0d8b0b57..8d72760a 100644
--- a/docs/tutorials/mirror_mirror_on_the_wall.rst
+++ b/docs/tutorials/mirror_mirror_on_the_wall.rst
@@ -392,7 +392,7 @@ So what does code with each of these look like?
 Stem Example
 ------------
 
-* `Benchmark Script <../.../../_static/example/benchmark_stem.py>`_
+* `Stem Benchmark Script <../.../../_static/example/benchmark_stem.py>`_
 
 .. literalinclude:: /_static/example/benchmark_server_descriptor_stem.py
    :language: python
@@ -400,7 +400,7 @@ Stem Example
 Metrics-lib Example
 -------------------
 
-* `Benchmark Script <../.../../_static/example/benchmark_metrics_lib.java>`_
+* `Metrics-lib Benchmark Script <../.../../_static/example/benchmark_metrics_lib.java>`_
 
 .. literalinclude:: /_static/example/benchmark_server_descriptor_metrics_lib.java
    :language: java
@@ -408,7 +408,7 @@ Metrics-lib Example
 Zoossh Example
 --------------
 
-* `Benchmark Script <../.../../_static/example/benchmark_zoossh.go>`_
+* `Zoossh Benchmark Script <../.../../_static/example/benchmark_zoossh.go>`_
 
 .. literalinclude:: /_static/example/benchmark_server_descriptor_zoossh.go
    :language: go





More information about the tor-commits mailing list