.. BridgeDB documentation master file, created by sphinx-quickstart on Sat Nov 23 02:37:56 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. BridgeDB developer documentation =============================================== .. image:: _static/bay-bridge.jpg :align: center ^^^^^^^^^^^^^^^^^ BridgeDB's README ^^^^^^^^^^^^^^^^^ .. toctree:: :maxdepth: 3 readme ^^^^^^^^^^^^^^^^^^^^^ Packages & Modules ^^^^^^^^^^^^^^^^^^^^^ .. toctree:: :maxdepth: 3 bridgedb ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Tor Bridge Descriptor Formats ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Please also see the `CollecTor`__ documentation on Tor Bridge descriptor formats. __ https://collector.torproject.org/formats.html#bridge-descriptors .. toctree:: :maxdepth: 4 descriptors Help Develop BridgeDB! ========================= To see all open tickets for BridgeDB, please `visit the Tor Project's Trac`__ instance. __ https://trac.torproject.org/projects/tor/query?status=!closed&component=BridgeDB&groupdesc=1&group=priority&col=id&col=summary&col=status&col=type&col=priority&col=changetime&order=priority Todo List ========= This TODO list is generated in an automated manner via the `Sphinx TODO extension`__, and it only includes portions documentation string within BridgeDB's codebase which have been marked with the Sphinx ``.. todo:`` directive. As such, this should be taken neither as a canonical nor complete list of tasks planned for future development, but rather a brief list of small(ish) places within the codebase that could use some attention. __ http://sphinx-doc.org/ext/todo.html#directive-todo .. todolist::