isislovecruft / bridgedb

18%

develop: 91%

LAST BUILD ON BRANCH feature/sphinx-docs

branch: feature/sphinx-docs

CHANGE BRANCH

x

Reset

• feature/sphinx-docs
• testing/feature/9865-test-harness-coverage
• feature/9865-test-harness-coverage
• develop
• testing/fix/9462C-ipaddr-portlist-module
• fix/9462C-ipaddr-portlist-module
• testing/fix/9462-refactor-netstatus-parsers_rdevelop
• testing/fix/9462-refactor-netstatus-parsers_r9462C
• fix/9462-refactor-netstatus-parsers_r9462C
• hotfix/9937-desc-gen_base64-padding-descDigest
• fix/9462-refactor-netstatus-parsers_r9462C_r2
• testing/sysrqb/bug5232_based_on_fix/9462_r9462C_r2
• testing/sysrqb/bug5232_based_on_fix/9462_r9462C_r2_test2
• testing/sysrqb/bug5232_r2_based_on_fix/9462_r9462C_r2_cherry-pick-7bb36dd0857
• testing/sysrqb/bug5232_r2_based_on_fix/9462_r9462C_r2_cherry-pick-44d2bc761c13
• testing/sysrqb/bug5232_r2_based_on_fix/9462_r9462C_r2
• fix/9013_r1
• fix/1606-based-on_bug1606_spec_update_rebased_r1
• hotfix/9462B-netstatus-returns-None
• fix/9873-convert-old-unittests_r3
• fix/6127-web-server-tracebacks
• fix/10559-keyid-in-pt-lines
• bridgedb-0.1.0
• master
• fix/6127-render_GET-traceback
• feature/10724-collect-timestamps-option
• fix/10737-post-args-redirects
• fix/9127-https-interface-ipv6
• feature/7520-social-dist-design_r1
• fix/9988-apply-patch
• fix/9988-rm-hashlibnew
• bridgedb-0.1.1
• fix/10811-add-SIGUSR1-handler
• bridgedb-0.1.2
• testing/tpo-sysrqb/bug9127
• testing/tpo-sysrqb/bug9264_rebased_0
• hotfix/ude-persistent
• testing/tpo-sysrqb/bug9264_rebased_1
• testing/tpo-sysrqb/bug9264_rebased_1-test2
• hotfix/9264-descdigest-none
• bridgedb-0.1.3
• hotfix/9264_2_rtl-2step
• bridgedb-0.1.4
• fix/11127-recaptcha-ssl
• fix/10809-gimp-captcha
• testing/fix/10809-gimp-captcha_r1
• fix/10809-gimp-captcha_r1
• fix/11127-recaptcha-ssl_10809r1_r1
• testing/tpo-sysrqb/bug9264_rebased_3
• fix/11231-additional-bug-fixes
• fix/9199-safelogging
• fix/11346-homepage-link
• fix/10803-remove-vidalia-update-options
• fix/11139-riseup
• fix/7550-9678-interactive-translations
• fix/11522-exc-in-email-dist
• hotfix/remove-sqlitedict-class
• hotfix/11522-gpg-signing
• hotfix/requirements-travis
• fix/11664-email-buffer-interface
• fix/5463-gpgme-homedir
• translations/2014-04-24-update-pot-file
• fix/5463-7547-7550-8241-11475-11753-email-rewrite
• translations/2014-04-24-update
• translations/2014-05-07-update
• fix/5463-sign-client-email-addr
• rransom/5463-ui-typos
• fix/11215-captcha-timeouts
• translations/2014-05-16-update
• bridgedb-0.2.1
• fix/9874-automate-email-tests
• hotfix/11215_12147-intervalstart
• hotfix/0.2.1-docstrings
• fix/12091-dkim-dunno
• fix/12086-rcptto-other-domain
• fix/12122-translator-notes
• translations/2014-06-06-update
• bridgedb-0.2.2
• hotfix/5463-email-line-recieved-logging
• fix/9385-fuzzy-email-matching
• rransom/fix/12147-schedule-unittest
• fix/12627-hotfixes
• fix/9385-fuzzy-email-matching_r1
• testing/coveralls-rcfile
• fix/11139-riseup_r1
• fix/12635-tbb-dl-links
• fix/12709-enable-fte
• bridgedb-0.2.3
• fix/stability-db
• hotfix/12627-additional-unicode-fix
• fix/9874-https
• fix/9874-email
• testing/tpo-common/develop
• fix/9874-remove-requirements.txt
• fix/9380-stem_r3
• fix/9380-stem_r4
• fix/12843-cc-spurning
• fix/make-config.py
• fix/12029-refactor-Bridges
• fix/12031-redis_r2
• fix/9380-stem_r5
• fix/12932-pt-args-spaces
• fix/9380-stem_r7
• fix/0.2.3-readme-testing-instructions
• fix/13123-bridgeline-spaces
• hotfix/0.2.3-html-footer-icons
• fix/11345-qrcodes_r2
• fix/12664-bridgeline-newlines_r2
• fix/14064-bridgeline-wrapping_r2
• fix/9380-stem_r8
• fix/14865-disable-obfs2
• bridgedb-0.2.4
• fix/4405-tor-exit-check_2_r1
• fix/9380-stem_r9
• hotfix/0.2.4-travis-pyeggcache
• hotfix/0.2.4-travis-matrix-update
• fix/9380-stem_r10
• hotfix/0.2.4-mechanize-tags
• fix/12872-bridge-geoip
• fix/12872-bridge-geoip_r1
• fix/12843-cc-spurning_r2
• fix/10385-python-gnupg
• fix/10385-python-gnupg_r1
• hotfix/0.2.4-bump-mako-version
• hotfix/0.2.4-bump-pygeoip-version
• hotfix/0.2.4-14797-var-bulkexitlist
• hotfix/0.2.4-14797-requirements
• hotfix/0.2.4-14797-4405-missing-proxylistfile
• fix/15155-instructions-string
• translations/2015-03-19-update
• translations/2015-03-20-update
• fix/12507-automate-documentation-builds
• hotfix/10385-init-gpg-ret
• hotfix/9380-duplicate-extrainfo-error
• fix/14065-vanilla-ipv6
• hotfix/3.0.0-twisted-14.0.2
• hotfix/0.3.0-twisted-14.0.2
• hotfix/0.3.0-twisted-14.0.2_r1
• bridgedb-0.3.0
• bridgedb-0.3.1
• hotfix/0.3.1-9385-levenshtein-distance
• fix/12504-config-pts
• fix/15464-ci-directives
• fix/15464-ci-directives_r1
• fix/13202-missing-pt-args
• fix/4771-log-tor-exits
• fix/4771-log-tor-exits_r1
• fix/1839-rotation-periods
• fix/15522-ipv6-enumeration
• fix/12505-5418-remove-old-block-code
• fix/12505-refactor-hashrings
• fix/12505-refactor-hashrings_r2
• fix/12505-refactor-hashrings_r3
• fix/12505-refactor-hashrings_r4
• fix/12505-refactor-hashrings_r5
• fix/12505-refactor-hashrings_r6
• fix/12505-refactor-hashrings_r7
• hotfix/0.3.1-pypy-support
• fix/15866-broken-bridgeauth
• develop_copy
• bridgedb-0.3.2
• hotfix/0.3.2-format-plain-bytes
• hotfix/0.3.2-error-pages
• fix/12505-12029-11330-hashrings
• fix/16273-gitweb-urls
• fix/12505-12029-11330-hashrings_r1
• fix/16330-eid-sds-2-fields
• fix/12505-12029-11330-hashrings_r2
• testing/rm-unused-legacy-test-code
• testing/nondeterminism-smtp-test
• testing/log-memaddrs
• fix/12505-12029-11330-hashrings_r3
• fix/12505-12029-11330-hashrings_r4
• fix/12505-12029-11330-hashrings_r5
• fix/12505-12029-11330-hashrings_r6
• fix/12506-separate-dist-dirs_6
• fix/12505-12029-11330-hashrings_r7
• fix/12506-separate-dist-dirs_7
• fix/12506-separate-dist-dirs_8
• fix/12505-12029-11330-hashrings_r8
• fix/12029-distribute-module_8
• fix/12506-separate-dist-dirs_9
• fix/12029-distribute-module_9
• fix/12505-11330-hashrings
• fix/12506-separate-dist-dirs
• fix/12029-distribute-module
• hotfix/0.3.2-remove-lib-dir
• hotfix/0.3.2-pep440
• fix/16616-hsdir-flag
• fix/14685-disable-obfs2
• bridgedb-0.3.5
• bridgedb-0.3.4
• fix/18237
• fix/18949
• bridgedb-0.3.6
• fix/19691
• bridgedb-0.3.7
• fix/22871_r1
• fix/24433
• fix/24460
• fix/3015-remove-buckets
• release/0.6.1
• bridgedb-0.6.1
• fix/24637
• fix/24636
• bridgedb-0.6.2
• fix/24704
• fix/24701
• release/0.6.3
• bridgedb-0.6.3
• fix/24432-json-str
• fix/24432-ignore-loopback
• bridgedb-0.6.4
• feature/25246
• fix/26023
• bridgedb-0.6.5

Remove the TODO header in doc builds for index.rst.

The sphinx.ext.todo seem not to be working…

It is supposed to work, I believe, by putting the following into a
docstring:

    class Foo(object):
        """A foo.

        .. todo:: Do something about bar.
        """

And then the `.. todolist::` directive in Sphinx will find all such
`.. todo::` directives in your code, and put them in a list (the way I
was doing it, these would be on the index.html page) with links to where
the `.. todo::` is in the source code.

However, this seems to *only* work in docstrings proper in Python, the
following do *not* get picked up by the `.. todolist::` Sphinx
directive:

    * Normal Python inline comments, i.e.:
        # .. todo:: There is this thing we should do.

    * Sphinx attribute inline comments, i.e.:
        #: .. todo:: There is also another thing we should do.

Because all of the TODOs in BridgeDB are currently within normal Python
inline comments, the `.. todolist::` on the index page doesn't include
anything, and thus there is an awkward looking, giant, blank header with
nothing underneath it. Thus, I'm taking out the header, but leaving in
the `.. todolist::` directive (so that we *can* use `.. todo::` in a
proper docstring in the future and it will be automatically included in
the documentation here).