GitLab is used only for code review, issue tracking and project management. Canonical locations for source code are still and

Verified Commit c931dd01 authored by Georg Koppen's avatar Georg Koppen
Browse files

fix: doc: Sphinx warnings when creating documentation

This should give us at least a clean html, text, and man build

Closes #40036.
parent 6dc6e94b
Pipeline #2095 passed with stage
in 110 minutes and 10 seconds
# Authors
The following people have contributed to Simple Bandwidth Scanner.
Thank you for helping make Tor better.
# Readme
[![Build Status](](
......@@ -97,7 +97,7 @@ html_theme = 'nature'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = []
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
......@@ -426,4 +426,4 @@ oldest measurements are 5 days old::
.. _bandwidth file spec:
......@@ -24,6 +24,7 @@ def valid_after_from_network_statuses(network_statuses):
attribute of a ``stem.descriptor.RouterStatusEntryV3``.
:param list network_statuses:
returns datetime:
for ns in network_statuses:
......@@ -228,7 +229,7 @@ class Relay:
Increment The number of times that a relay has been queued
to be measured.
It is call from :funf:`~sbws.core.scaner.main_loop`.
It is call from :func:`~sbws.core.scaner.main_loop`.
......@@ -468,7 +469,7 @@ class RelayList:
Increment the number of times that any relay has been queued to be
It is call from :funf:`~sbws.core.scaner.main_loop`.
It is call from :func:`~sbws.core.scaner.main_loop`.
It is read and stored in a ``state`` file.
......@@ -97,6 +97,7 @@ class RelayPrioritizer:
measurements that did not succed.
:param bool return_fraction: whether to return only a fraction of the
relays seen in the network or return all.
return: a generator of the new ordered list of relays to measure next.
......@@ -558,7 +558,7 @@ class ResultErrorSecondRelay(ResultError):
A second suitable relay is a relay that:
- Has at least equal bandwidth as the relay to measure.
- If the relay to measure is not an exit,
- If the relay to measure is not an exit, \
the second relay is an exit without `bad` flag and can exit to port 443.
- If the relay to measure is an exit, the second relay is not an exit.
......@@ -625,7 +625,7 @@ class V3BWLine(object):
:param dict kwargs: extra headers.
.. note:: tech-debt: move node_id and bw to kwargs and just ensure that
the required values are in **kwargs
the required values are in ``**kwargs``
def __init__(self, node_id, bw, **kwargs):
assert isinstance(node_id, str)
......@@ -118,7 +118,8 @@ def parse_user_torrc_config(torrc, torrc_text):
"""Parse the user configuration torrc text call `extra_lines`
to a dictionary suitable to use with stem and return a new torrc
dictionary that merges that dictionary with the existing torrc.
extra_lines =
Log debug file /tmp/tor-debug.log
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment