1.. simple-bw-scanner documentation master file, created by 2 sphinx-quickstart on Fri Mar 23 16:20:02 2018. 3 You can adapt this file completely to your liking, but it should at least 4 contain the root `toctree` directive. 5 6.. raw:: html 7 8 <script type="text/javascript"> 9 if (String(window.location).indexOf("readthedocs") !== -1) { 10 window.alert('The documentation has moved, redirecting...'); 11 window.location.replace('https://tpo.pages.torproject.net/network-health/sbws'); 12 } 13 </script> 14 <noscript> 15 NOTE: documentation has moved from https://sbws.readthedocs.org to 16 https://tpo.pages.torproject.net/network-health/sbws 17 </noscript> 18 19Welcome to Simple Bandwidth Scanner's documentation! 20==================================================== 21 22User main documentation 23------------------------ 24 25Included in the 26`repository root <https://gitlab.torproject.org/tpo/network-health/sbws>`_ 27and in ``sbws`` Debian package: 28 29.. toctree:: 30 :maxdepth: 1 31 32 README 33 INSTALL 34 DEPLOY 35 CHANGELOG 36 AUTHORS 37 man_sbws 38 man_sbws.ini 39 40.. _dev_doc: 41 42Developer/technical documentation 43---------------------------------- 44 45Included in the 46`docs directory <https://gitlab.torproject.org/tpo/network-health/sbws/-/tree/main/docs>`_ and in 47``sbws-doc`` Debian package: 48 49.. toctree:: 50 :maxdepth: 1 51 52 contributing 53 testing 54 documenting 55 how_works 56 generator 57 torflow_aggr 58 differences 59 code_design 60 state 61 config 62 config_tor 63 sbws 64 implementation 65 bandwidth_distribution 66 tor_bandwidth_files 67 bandwidth_authorities 68 monitoring_bandwidth 69 roadmap 70 glossary 71 faq 72 73Proposals: 74 75.. toctree:: 76 :maxdepth: 1 77 :glob: 78 79 proposals/* 80 81Indices and tables 82------------------- 83 84* :ref:`genindex` 85* :ref:`modindex` 86* :ref:`search` 87