commit 8cfd99786f6a70c9d7d60e0d300b546a2397e7c1 Author: juga0 juga@riseup.net Date: Wed Apr 14 15:53:05 2021 +0000
fix: doc: Replace md by rst and rm dep
Get rid of the last documentation in markdown and remove extra dependency! --- AUTHORS.md => AUTHORS.rst | 16 +++--- LICENSE.md | 39 -------------- LICENSE.rst | 125 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 71 ------------------------- README.rst | 74 ++++++++++++++++++++++++++ docs/source/AUTHORS.md | 1 - docs/source/AUTHORS.rst | 1 + docs/source/README.md | 1 - docs/source/README.rst | 1 + docs/source/conf.py | 4 -- docs/source/documenting.rst | 5 +- setup.cfg | 1 - 12 files changed, 211 insertions(+), 128 deletions(-)
diff --git a/AUTHORS.md b/AUTHORS.rst similarity index 50% rename from AUTHORS.md rename to AUTHORS.rst index 1e8641e..d4b2276 100644 --- a/AUTHORS.md +++ b/AUTHORS.rst @@ -1,14 +1,14 @@ Authors =======
-The following people have contributed to Simple Bandwidth Scanner. -Thank you for helping make Tor better. +The following people have contributed to Simple Bandwidth Scanner. Thank +you for helping make Tor better.
-* anadahz -* George Kadianakis -* Georg Koppen -* juga -* Matt Traudt -* teor +- anadahz +- George Kadianakis +- Georg Koppen +- juga +- Matt Traudt +- teor
*Last updated: 2020-06-26 on d7a822bf* diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index b823bcc..0000000 --- a/LICENSE.md +++ /dev/null @@ -1,39 +0,0 @@ -CC0 1.0 Universal -================== - -Statement of Purpose ---------------------- - -The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work"). - -Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others. - -For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights. - -1. Copyright and Related Rights. --------------------------------- -A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following: - -i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work; -ii. moral rights retained by the original author(s) and/or performer(s); -iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work; -iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below; -v. rights protecting the extraction, dissemination, use and reuse of data in a Work; -vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and -vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof. - -2. Waiver. ------------ -To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equ itable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose. - -3. Public License Fallback. ----------------------------- -Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose. - -4. Limitations and Disclaimers. --------------------------------- - -a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document. -b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law. -c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work. -d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work. diff --git a/LICENSE.rst b/LICENSE.rst new file mode 100644 index 0000000..671202b --- /dev/null +++ b/LICENSE.rst @@ -0,0 +1,125 @@ +CC0 1.0 Universal +================= + +Statement of Purpose +-------------------- + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an “owner”) of an original work +of authorship and/or a database (each, a “Work”). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works (“Commons”) that the public can reliably and without +fear of later claims of infringement build upon, modify, incorporate in +other works, reuse and redistribute as freely as possible in any form +whatsoever and for any purposes, including without limitation commercial +purposes. These owners may contribute to the Commons to promote the +ideal of a free culture and the further production of creative, cultural +and scientific works, or to gain reputation or greater distribution for +their Work in part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the “Affirmer”), to the extent that he or +she is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under +its terms, with knowledge of his or her Copyright and Related Rights in +the Work and the meaning and intended legal effect of CC0 on those +rights. + +1. Copyright and Related Rights. +-------------------------------- + +A Work made available under CC0 may be protected by copyright and +related or neighboring rights (“Copyright and Related Rights”). +Copyright and Related Rights include, but are not limited to, the +following: + +i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; +ii. moral rights retained by the original author(s) and/or + performer(s); +iii. publicity and privacy rights pertaining to a person’s image or + likeness depicted in a Work; +iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; +v. rights protecting the extraction, dissemination, use and reuse of + data in a Work; +vi. database rights (such as those arising under Directive 96/9/EC of + the European Parliament and of the Council of 11 March 1996 on the + legal protection of databases, and under any national + implementation thereof, including any amended or successor version + of such directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. +---------- + +To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably +and unconditionally waives, abandons, and surrenders all of Affirmer’s +Copyright and Related Rights and associated claims and causes of action, +whether now known or unknown (including existing as well as future +claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or +future medium and for any number of copies, and (iv) for any purpose +whatsoever, including without limitation commercial, advertising or +promotional purposes (the “Waiver”). Affirmer makes the Waiver for the +benefit of each member of the public at large and to the detriment of +Affirmer’s heirs and successors, fully intending that such Waiver shall +not be subject to revocation, rescission, cancellation, termination, or +any other legal or equitable action to disrupt the quiet enjoyment of +the Work by the public as contemplated by Affirmer’s express Statement +of Purpose. + +3. Public License Fallback. +--------------------------- + +Should any part of the Waiver for any reason be judged legally invalid +or ineffective under applicable law, then the Waiver shall be preserved +to the maximum extent permitted taking into account Affirmer’s express +Statement of Purpose. In addition, to the extent the Waiver is so judged +Affirmer hereby grants to each affected person a royalty-free, non +transferable, non sublicensable, non exclusive, irrevocable and +unconditional license to exercise Affirmer’s Copyright and Related +Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any +number of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +“License”). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, +such partial invalidity or ineffectiveness shall not invalidate the +remainder of the License, and in such case Affirmer hereby affirms that +he or she will not (i) exercise any of his or her remaining Copyright +and Related Rights in the Work or (ii) assert any associated claims and +causes of action with respect to the Work, in either case contrary to +Affirmer’s express Statement of Purpose. + +4. Limitations and Disclaimers. +------------------------------- + +a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. +b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. +c. Affirmer disclaims responsibility for clearing rights of other + persons that may apply to the Work or any use thereof, including + without limitation any person’s Copyright and Related Rights in the + Work. Further, Affirmer disclaims responsibility for obtaining any + necessary consents, permissions or other rights required for any use + of the Work. +d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/README.md b/README.md deleted file mode 100644 index fe12cba..0000000 --- a/README.md +++ /dev/null @@ -1,71 +0,0 @@ -Readme -====== - -[%5D(https://travis-c...) - -Simple Bandwidth Scanner (called `sbws`) is a Tor bandwidth scanner that -generates bandwidth files to be used by Directory Authorities. - -The scanner measures the bandwidth of each relay in the Tor network -(except the directory authorities) by creating a two hops circuit -with the relay. It then measures the bandwidth by downloading data -from a destination Web Server and stores the measurements. - -The generator read the measurements, aggregates, filters and -scales them using torflow's scaling method. -Then it generates a bandwidth list file that is read -by a directory authority to report relays’ bandwidth in its vote. - -**WARNING**: This software is intended to be run by researchers using a test -Tor network, such as chutney or shadow, or by the Tor bandwidth authorities -on the public Tor network. -Please do not run this software on the public Tor network unless you are one -of the Tor bandwidth authorities, to avoid creating unnecessary traffic. - -**ADVICE**: It is recommended to read this documentation at -[Read the Docs](https://sbws.rtfd.io). In -[Tor Project Gitlab](https://gitlab.torproject.org/tpo/network-health/sbws) -(tpo Gitlab) some links won't be properly rendered. -It can also be read after installing the Debian package ``sbws-doc`` in -``/usr/share/doc/sbws`` or after building it locally as explained in -``./docs/source/documenting.rst``. - - -Installing ------------- - -See [./INSTALL.rst](INSTALL.rst) (in local directory or tpo Gitlab) or -[INSTALL.html](INSTALL.html) (local build or Read the Docs). - -Deploying and running ---------------------- - -See [./DEPLOY.rst](DEPLOY.rst) (in local directory or tpo Gitlab) or -[DEPLOY.html](DEPLOY.html) (local build or Read the Docs). - -Changelog --------------- - -See [./CHANGELOG.rst](CHANGELOG.rst) (in local directory or tpo Gitlab) or -[CHANGELOG.html](CHANGELOG.html) (local build or Read the Docs). - -Documentation --------------- - -More extensive documentation can be found in the ``./docs`` directory, -and online at [sbws.rtfd.io](https://sbws.readthedocs.io). - -## License - -This work is in the public domain within the United States. - -We waive copyright and related rights in the work worldwide through the -[CC0-1.0 license](https://creativecommons.org/publicdomain/zero/1.0). - -You can find a copy of the CC0 Public Domain Dedication along with this -software in ./LICENSE.md - -## Authors - -See [./AUTHORS.md](AUTHORS.md) (in local directory or tpo Gitlab) or -[AUTHORS.html](AUTHORS.html) (local build or Read the Docs). diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..8849cac --- /dev/null +++ b/README.rst @@ -0,0 +1,74 @@ +Readme +====== + +`Build +Status https://travis-ci.org/https://travis-ci.org/torproject/sbws`__ + +Simple Bandwidth Scanner (called ``sbws``) is a Tor bandwidth scanner +that generates bandwidth files to be used by Directory Authorities. + +The scanner measures the bandwidth of each relay in the Tor network +(except the directory authorities) by creating a two hops circuit with +the relay. It then measures the bandwidth by downloading data from a +destination Web Server and stores the measurements. + +The generator read the measurements, aggregates, filters and scales them +using torflow’s scaling method. Then it generates a bandwidth list file +that is read by a directory authority to report relays’ bandwidth in its +vote. + +**WARNING**: This software is intended to be run by researchers using a +test Tor network, such as chutney or shadow, or by the Tor bandwidth +authorities on the public Tor network. Please do not run this software +on the public Tor network unless you are one of the Tor bandwidth +authorities, to avoid creating unnecessary traffic. + +**ADVICE**: It is recommended to read this documentation at `Read the +Docs https://sbws.rtfd.io`__. In `Tor Project +Gitlab https://gitlab.torproject.org/tpo/network-health/sbws`__ (tpo +Gitlab) some links won’t be properly rendered. It can also be read after +installing the Debian package ``sbws-doc`` in ``/usr/share/doc/sbws`` or +after building it locally as explained in +``./docs/source/documenting.rst``. + +Installing +---------- + +See `./INSTALL.rst <INSTALL.rst>`__ (in local directory or tpo Gitlab) +or `INSTALL.html <INSTALL.html>`__ (local build or Read the Docs). + +Deploying and running +--------------------- + +See `./DEPLOY.rst <DEPLOY.rst>`__ (in local directory or tpo Gitlab) or +`DEPLOY.html <DEPLOY.html>`__ (local build or Read the Docs). + +Changelog +--------- + +See `./CHANGELOG.rst <CHANGELOG.rst>`__ (in local directory or tpo +Gitlab) or `CHANGELOG.html <CHANGELOG.html>`__ (local build or Read the +Docs). + +Documentation +------------- + +More extensive documentation can be found in the ``./docs`` directory, +and online at `sbws.rtfd.io https://sbws.readthedocs.io`__. + +License +------- + +This work is in the public domain within the United States. + +We waive copyright and related rights in the work worldwide through the +`CC0-1.0 license https://creativecommons.org/publicdomain/zero/1.0`__. + +You can find a copy of the CC0 Public Domain Dedication along with this +software in ./LICENSE.md + +Authors +------- + +See `./AUTHORS.md <AUTHORS.md>`__ (in local directory or tpo Gitlab) or +`AUTHORS.html <AUTHORS.html>`__ (local build or Read the Docs). diff --git a/docs/source/AUTHORS.md b/docs/source/AUTHORS.md deleted file mode 120000 index 2d2e840..0000000 --- a/docs/source/AUTHORS.md +++ /dev/null @@ -1 +0,0 @@ -../../AUTHORS.md \ No newline at end of file diff --git a/docs/source/AUTHORS.rst b/docs/source/AUTHORS.rst new file mode 120000 index 0000000..4968901 --- /dev/null +++ b/docs/source/AUTHORS.rst @@ -0,0 +1 @@ +../../AUTHORS.rst \ No newline at end of file diff --git a/docs/source/README.md b/docs/source/README.md deleted file mode 120000 index fe84005..0000000 --- a/docs/source/README.md +++ /dev/null @@ -1 +0,0 @@ -../../README.md \ No newline at end of file diff --git a/docs/source/README.rst b/docs/source/README.rst new file mode 120000 index 0000000..c768ff7 --- /dev/null +++ b/docs/source/README.rst @@ -0,0 +1 @@ +../../README.rst \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index 1f33c71..d242147 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -197,8 +197,4 @@ epub_exclude_files = ['search.html'] # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True
-source_parsers = { - '.md': 'recommonmark.parser.CommonMarkParser', -} - numfig = True diff --git a/docs/source/documenting.rst b/docs/source/documenting.rst index bc74dae..8dd31f0 100644 --- a/docs/source/documenting.rst +++ b/docs/source/documenting.rst @@ -6,7 +6,6 @@ Installing and building the documentation To build the documentation, extra Python dependencies are needed:
- Sphinx_ -- recommonmark_ - Pylint_ (only to update the diagrams)
To install them from ``sbws``:: @@ -43,7 +42,7 @@ They are included in most distributions. In Debian install them running::
.. _Sphinx: https://www.sphinx-doc.org -.. _recommonmark: https://recommonmark.readthedocs.io/ .. _Pylint: https://www.pylint.org/ .. _Tex: https://www.tug.org/texlive/acquire.html -.. _dvipng: https://www.nongnu.org/dvipng/ \ No newline at end of file +.. _dvipng: https://www.nongnu.org/dvipng/ + diff --git a/setup.cfg b/setup.cfg index 2ba9548..0074a1d 100644 --- a/setup.cfg +++ b/setup.cfg @@ -53,7 +53,6 @@ test = doc = sphinx pylint - recommonmark dev = flake8 flake8-docstrings