commit abd5467a312272abffaf761e2e7825a64681e5d8 Author: Damian Johnson atagar@torproject.org Date: Fri Aug 4 17:58:30 2017 -0700

Remove Sphinx site

Now that we're done with the new site dropping the Sphinx copy I was previously running with. That site was based on stem.torproject.org. Sphinx was a good fit for Stem since as a library API information is a foremost need, but that isn't the case for Nyx. Making our own site is both simpler *and* gives us greater control to make something that looks great. --- .gitignore | 3 +- docs/Makefile | 131 ---- docs/_static/buttons/bug_tracker.png | Bin 28650 -> 0 bytes docs/_static/buttons/change_log.png | Bin 26676 -> 0 bytes docs/_static/buttons/download.png | Bin 27728 -> 0 bytes docs/_static/buttons/faq.png | Bin 27450 -> 0 bytes docs/_static/buttons/resources/bug_tracker.xcf | Bin 83732 -> 0 bytes .../buttons/resources/button_background.xcf | Bin 53014 -> 0 bytes docs/_static/buttons/resources/change_log.xcf | Bin 66972 -> 0 bytes docs/_static/buttons/resources/download.xcf | Bin 84072 -> 0 bytes docs/_static/buttons/resources/faq.xcf | Bin 89198 -> 0 bytes docs/_static/buttons/resources/screenshots.xcf | Bin 69094 -> 0 bytes .../buttons/resources/screenshots_large.png | Bin 15450 -> 0 bytes docs/_static/buttons/screenshots.png | Bin 29683 -> 0 bytes docs/_static/favicon.png | Bin 1555 -> 0 bytes docs/_static/haiku.css_t | 456 ------------ docs/_static/label/archlinux.png | Bin 1618 -> 0 bytes docs/_static/label/debian.png | Bin 1339 -> 0 bytes docs/_static/label/fedora.png | Bin 1399 -> 0 bytes docs/_static/label/freebsd.png | Bin 1645 -> 0 bytes docs/_static/label/gentoo.png | Bin 1147 -> 0 bytes docs/_static/label/osx.png | Bin 1767 -> 0 bytes docs/_static/label/python_package_index.png | Bin 3106 -> 0 bytes docs/_static/label/redhat.png | Bin 1492 -> 0 bytes docs/_static/label/resources/archlinux.xcf | Bin 3573 -> 0 bytes docs/_static/label/resources/debian.xcf | Bin 3137 -> 0 bytes docs/_static/label/resources/fedora.xcf | Bin 3145 -> 0 bytes docs/_static/label/resources/freebsd.xcf | Bin 3611 -> 0 bytes docs/_static/label/resources/gentoo.xcf | Bin 2779 -> 0 bytes docs/_static/label/resources/osx.xcf | Bin 3820 -> 0 bytes .../label/resources/python_package_index.xcf | Bin 6285 -> 0 bytes docs/_static/label/resources/redhat.xcf | Bin 3504 -> 0 bytes docs/_static/label/resources/slackware.xcf | Bin 3567 -> 0 bytes docs/_static/label/resources/source_repository.xcf | Bin 5479 -> 0 bytes docs/_static/label/resources/ubuntu.xcf | Bin 3316 -> 0 bytes docs/_static/label/slackware.png | Bin 1783 -> 0 bytes docs/_static/label/source_repository.png | Bin 2757 -> 0 bytes docs/_static/label/ubuntu.png | Bin 1126 -> 0 bytes docs/_static/logo.png | Bin 6885 -> 0 bytes docs/_static/logo_orig.png | Bin 9536 -> 0 bytes docs/_static/section/download/archlinux.png | Bin 7144 -> 0 bytes docs/_static/section/download/debian.png | Bin 5646 -> 0 bytes docs/_static/section/download/fedora.png | Bin 4447 -> 0 bytes docs/_static/section/download/freebsd.png | Bin 18114 -> 0 bytes docs/_static/section/download/gentoo.png | Bin 16245 -> 0 bytes docs/_static/section/download/git.png | Bin 2273 -> 0 bytes docs/_static/section/download/git_alt.png | Bin 4749 -> 0 bytes docs/_static/section/download/osx.png | Bin 3660 -> 0 bytes docs/_static/section/download/pypi.png | Bin 3827 -> 0 bytes docs/_static/section/download/redhat.png | Bin 4944 -> 0 bytes docs/_static/section/download/resources/fedora.svg | 74 -- docs/_static/section/download/slackware.png | Bin 10938 -> 0 bytes docs/_static/section/download/ubuntu.png | Bin 4814 -> 0 bytes .../section/screenshots/acs_display_failure.png | Bin 161127 -> 0 bytes .../screenshots/acs_display_failure_full.png | Bin 405426 -> 0 bytes docs/_static/section/screenshots/config.png | Bin 179183 -> 0 bytes docs/_static/section/screenshots/config_full.png | Bin 603692 -> 0 bytes docs/_static/section/screenshots/connections.png | Bin 133573 -> 0 bytes .../section/screenshots/connections_full.png | Bin 557585 -> 0 bytes docs/_static/section/screenshots/interpreter.png | Bin 269313 -> 0 bytes .../section/screenshots/interpreter_full.png | Bin 726289 -> 0 bytes docs/_static/section/screenshots/main.png | Bin 89546 -> 0 bytes docs/_static/section/screenshots/main_full.png | Bin 335698 -> 0 bytes docs/_static/section/screenshots/torrc.png | Bin 103308 -> 0 bytes docs/_static/section/screenshots/torrc_full.png | Bin 531290 -> 0 bytes docs/_static/section/screenshots/vidalia.png | Bin 21201 -> 0 bytes docs/_static/section/screenshots/vidalia_full.png | Bin 44187 -> 0 bytes docs/_static/style.css | 17 - docs/_templates/layout.html | 80 -- docs/change_log.rst | 77 -- docs/change_log_legacy.rst | 803 --------------------- docs/conf.py | 239 ------ docs/contents.rst | 12 - docs/download.rst | 178 ----- docs/faq.rst | 291 -------- docs/index.rst | 60 -- docs/republish | 7 - docs/republish.py | 89 --- docs/roles.py | 73 -- docs/screenshots.rst | 28 - 80 files changed, 1 insertion(+), 2617 deletions(-)

diff --git a/.gitignore b/.gitignore index ed86815..b07d3e0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ *.pyc +*.swp src/stem/ build/ -docs/_build/ -*.swp

diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index e9ca020..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,131 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest - -help: - @echo "Please use `make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - -rm -rf $(BUILDDIR)/* - @rm -f ./nyx.* ./modules.rst - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Nyx.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Nyx.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/Nyx" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Nyx" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run `make' in that directory to run these through (pdf)latex" \ - "(use `make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - make -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/_static/buttons/bug_tracker.png b/docs/_static/buttons/bug_tracker.png deleted file mode 100644 index 64650cb..0000000 Binary files a/docs/_static/buttons/bug_tracker.png and /dev/null differ diff --git a/docs/_static/buttons/change_log.png b/docs/_static/buttons/change_log.png deleted file mode 100644 index e74fefc..0000000 Binary files a/docs/_static/buttons/change_log.png and /dev/null differ diff --git a/docs/_static/buttons/download.png b/docs/_static/buttons/download.png deleted file mode 100644 index 55eb007..0000000 Binary files a/docs/_static/buttons/download.png and /dev/null differ diff --git a/docs/_static/buttons/faq.png b/docs/_static/buttons/faq.png deleted file mode 100644 index c2cf142..0000000 Binary files a/docs/_static/buttons/faq.png and /dev/null differ diff --git a/docs/_static/buttons/resources/bug_tracker.xcf b/docs/_static/buttons/resources/bug_tracker.xcf deleted file mode 100644 index f938a92..0000000 Binary files a/docs/_static/buttons/resources/bug_tracker.xcf and /dev/null differ diff --git a/docs/_static/buttons/resources/button_background.xcf b/docs/_static/buttons/resources/button_background.xcf deleted file mode 100644 index 3766bce..0000000 Binary files a/docs/_static/buttons/resources/button_background.xcf and /dev/null differ diff --git a/docs/_static/buttons/resources/change_log.xcf b/docs/_static/buttons/resources/change_log.xcf deleted file mode 100644 index 70b243d..0000000 Binary files a/docs/_static/buttons/resources/change_log.xcf and /dev/null differ diff --git a/docs/_static/buttons/resources/download.xcf b/docs/_static/buttons/resources/download.xcf deleted file mode 100644 index 14d3339..0000000 Binary files a/docs/_static/buttons/resources/download.xcf and /dev/null differ diff --git a/docs/_static/buttons/resources/faq.xcf b/docs/_static/buttons/resources/faq.xcf deleted file mode 100644 index ce52f63..0000000 Binary files a/docs/_static/buttons/resources/faq.xcf and /dev/null differ diff --git a/docs/_static/buttons/resources/screenshots.xcf b/docs/_static/buttons/resources/screenshots.xcf deleted file mode 100644 index 8d3bf05..0000000 Binary files a/docs/_static/buttons/resources/screenshots.xcf and /dev/null differ diff --git a/docs/_static/buttons/resources/screenshots_large.png b/docs/_static/buttons/resources/screenshots_large.png deleted file mode 100644 index 670ba9d..0000000 Binary files a/docs/_static/buttons/resources/screenshots_large.png and /dev/null differ diff --git a/docs/_static/buttons/screenshots.png b/docs/_static/buttons/screenshots.png deleted file mode 100644 index 6979733..0000000 Binary files a/docs/_static/buttons/screenshots.png and /dev/null differ diff --git a/docs/_static/favicon.png b/docs/_static/favicon.png deleted file mode 100644 index 00dc124..0000000 Binary files a/docs/_static/favicon.png and /dev/null differ diff --git a/docs/_static/haiku.css_t b/docs/_static/haiku.css_t deleted file mode 100644 index cd3b28d..0000000 --- a/docs/_static/haiku.css_t +++ /dev/null @@ -1,456 +0,0 @@ -/* - * haiku.css_t - * ~~~~~~~~~~~ - * - * Sphinx stylesheet -- haiku theme. - * - * Adapted from http://haiku-os.org/docs/Haiku-doc.css. - * Original copyright message: - * - * Copyright 2008-2009, Haiku. All rights reserved. - * Distributed under the terms of the MIT License. - * - * Authors: - * Francois Revol revol@free.fr - * Stephan Assmus superstippi@gmx.de - * Braden Ewing brewin@gmail.com - * Humdinger humdingerb@gmail.com - * - * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -@import url("basic.css"); - -html { - margin: 0px; - padding: 0px; - background: #FFF url(bg-page.png) top left repeat-x; -} - -body { - line-height: 1.5; - margin: auto; - padding: 0px; - font-family: "DejaVu Sans", Arial, Helvetica, sans-serif; - min-width: 59em; - max-width: 70em; - color: {{ theme_textcolor }}; -} - -div.footer { - padding: 8px; - font-size: 11px; - text-align: center; - letter-spacing: 0.5px; -} - -/* link colors and text decoration */ - -a:link { - font-weight: bold; - text-decoration: none; - color: {{ theme_linkcolor }}; -} - -a:visited { - font-weight: bold; - text-decoration: none; - color: {{ theme_visitedlinkcolor }}; -} - -a:hover, a:active { - text-decoration: underline; - color: {{ theme_hoverlinkcolor }}; -} - -/* Some headers act as anchors, don't give them a hover effect */ - -h1 a:hover, a:active { - text-decoration: none; - color: {{ theme_headingcolor }}; -} - -h2 a:hover, a:active { - text-decoration: none; - color: {{ theme_headingcolor }}; -} - -h3 a:hover, a:active { - text-decoration: none; - color: {{ theme_headingcolor }}; -} - -h4 a:hover, a:active { - text-decoration: none; - color: {{ theme_headingcolor }}; -} - -a.headerlink { - color: #a7ce38; - padding-left: 5px; -} - -a.headerlink:hover { - color: #a7ce38; -} - -/* basic text elements */ - -div.content { - margin-top: 20px; - margin-left: 40px; - margin-right: 40px; - margin-bottom: 50px; - font-size: 0.9em; -} - -/* heading and navigation */ - -div.header { - position: relative; - left: 0px; - top: 0px; - height: 85px; - /* background: #eeeeee; */ - padding: 0 40px; -} -div.header h1 { - font-size: 1.6em; - font-weight: normal; - letter-spacing: 1px; - color: {{ theme_headingcolor }}; - border: 0; - margin: 0; - padding-top: 15px; -} -div.header h1 a { - font-weight: normal; - color: {{ theme_headingcolor }}; -} -div.header h2 { - font-size: 1.3em; - font-weight: normal; - letter-spacing: 1px; - text-transform: uppercase; - color: #aaa; - border: 0; - margin-top: -3px; - padding: 0; -} - -div.header img.rightlogo { - float: right; -} - - -div.title { - font-size: 1.3em; - font-weight: bold; - color: {{ theme_headingcolor }}; - border-bottom: dotted thin #e0e0e0; - margin-bottom: 25px; -} -div.topnav { - /* background: #e0e0e0; */ -} -div.topnav p { - margin-top: 0; - margin-left: 40px; - margin-right: 40px; - margin-bottom: 0px; - font-size: 0.8em; -} -div.bottomnav { - background: #eeeeee; -} -div.bottomnav p { - margin-right: 40px; - font-size: 0.8em; -} - -a.uplink { - font-weight: normal; -} - - -/* contents box */ - -table.index { - margin: 0px 0px 30px 30px; - padding: 1px; - border-width: 1px; - border-style: dotted; - border-color: #e0e0e0; -} -table.index tr.heading { - background-color: #e0e0e0; - text-align: center; - font-weight: bold; - font-size: 1.1em; -} -table.index tr.index { - background-color: #eeeeee; -} -table.index td { - padding: 5px 20px; -} - -table.index a:link, table.index a:visited { - font-weight: normal; - text-decoration: none; - color: {{ theme_linkcolor }}; -} -table.index a:hover, table.index a:active { - text-decoration: underline; - color: {{ theme_hoverlinkcolor }}; -} - - -/* Haiku User Guide styles and layout */ - -/* Rounded corner boxes */ -/* Common declarations */ -div.admonition { - -webkit-border-radius: 10px; - -khtml-border-radius: 10px; - -moz-border-radius: 10px; - border-radius: 10px; - border-style: dotted; - border-width: thin; - border-color: #dcdcdc; - padding: 10px 15px 10px 15px; - margin-bottom: 15px; - margin-top: 15px; -} -div.note { - padding: 10px 15px 10px 80px; - background: #e4ffde url(alert_info_32.png) 15px 15px no-repeat; - min-height: 42px; -} -div.warning { - padding: 10px 15px 10px 80px; - background: #fffbc6 url(alert_warning_32.png) 15px 15px no-repeat; - min-height: 42px; -} -div.seealso { - background: #e4ffde; -} - -/* More layout and styles */ -h1 { - font-size: 1.3em; - font-weight: bold; - color: {{ theme_headingcolor }}; - border-bottom: dotted thin #e0e0e0; - margin-top: 30px; -} - -h2 { - font-size: 1.2em; - font-weight: normal; - color: {{ theme_headingcolor }}; - border-bottom: dotted thin #e0e0e0; - margin-top: 30px; -} - -h3 { - font-size: 1.1em; - font-weight: normal; - color: {{ theme_headingcolor }}; - margin-top: 30px; -} - -h4 { - font-size: 1.0em; - font-weight: normal; - color: {{ theme_headingcolor }}; - margin-top: 30px; -} - -p { - text-align: justify; -} - -p.last { - margin-bottom: 0; -} - -ol { - padding-left: 20px; -} - -ul { - padding-left: 5px; - margin-top: 3px; -} - -li { - line-height: 1.3; -} - -div.content li { - -moz-background-clip:border; - -moz-background-inline-policy:continuous; - -moz-background-origin:padding; - background: transparent url(bullet_orange.png) no-repeat scroll left 0.45em; - list-style-image: none; - list-style-type: none; - padding: 0 0 0 1.666em; - margin-bottom: 3px; -} - -td { - vertical-align: top; -} - -tt { - background-color: #e2e2e2; - font-size: 1.0em; - font-family: monospace; -} - -pre { - border-color: #0c3762; - border-style: dotted; - border-width: thin; - margin: 0 0 12px 0; - padding: 0.8em; - background-color: #f0f0f0; -} - -hr { - border-top: 1px solid #ccc; - border-bottom: 0; - border-right: 0; - border-left: 0; - margin-bottom: 10px; - margin-top: 20px; -} - -/* printer only pretty stuff */ -@media print { - .noprint { - display: none; - } - /* for acronyms we want their definitions inlined at print time */ - acronym[title]:after { - font-size: small; - content: " (" attr(title) ")"; - font-style: italic; - } - /* and not have mozilla dotted underline */ - acronym { - border: none; - } - div.topnav, div.bottomnav, div.header, table.index { - display: none; - } - div.content { - margin: 0px; - padding: 0px; - } - html { - background: #FFF; - } -} - -.viewcode-back { - font-family: "DejaVu Sans", Arial, Helvetica, sans-serif; -} - -div.viewcode-block:target { - background-color: #f4debf; - border-top: 1px solid #ac9; - border-bottom: 1px solid #ac9; - margin: -1px -12px; - padding: 0 12px; -} - -/* Navbar */ - -#navbar { - list-style: none; - margin: 0; - padding: 0; - float: left; - position: relative; -} - -#navbar li { - float: left; - position: relative; -} - -/* top navbar items */ - -#navbar li a { - float: left; - display: block; - text-decoration: none; - color: #666; - font-weight: normal; - text-indent: 10px; - width: 130px; - font-size: 0.9em; -} - -#navbar li:hover a, -#navbar li a:hover { - font-weight: normal; - background: #999; - color: #fff; -} - -/* start child items as invisible, but make them visible on hover */ - -#navbar ul { - display: none; -} - -#navbar li:hover ul { - display: block; -} - -/* attributes for child navbar items */ - -#navbar ul { - float: none; - position: absolute; - list-style: none; - margin: 0; - padding: 0; - top: 1.1em; - left: 0; -} - -#navbar ul li { - float: none; - clear: none; - margin: 0; - padding: 0; - width: auto; - color: #666; -} - -#navbar li:hover ul li a, -#navbar ul li { - font-weight: normal; - text-indent: 5px; - line-height: 200%; - display: block; - padding: 0 0 0 0; - float: none; - color: #666; - background-color: #e0e0e0; -} - -#navbar li:hover ul li a:hover, -#navbar ul li a:hover { - font-weight: normal; - text-indent: 5px; - background-color: #c1c1c1; - color: #000; -} - diff --git a/docs/_static/label/archlinux.png b/docs/_static/label/archlinux.png deleted file mode 100644 index c27a4f6..0000000 Binary files a/docs/_static/label/archlinux.png and /dev/null differ diff --git a/docs/_static/label/debian.png b/docs/_static/label/debian.png deleted file mode 100644 index 7f7b79d..0000000 Binary files a/docs/_static/label/debian.png and /dev/null differ diff --git a/docs/_static/label/fedora.png b/docs/_static/label/fedora.png deleted file mode 100644 index b9661f6..0000000 Binary files a/docs/_static/label/fedora.png and /dev/null differ diff --git a/docs/_static/label/freebsd.png b/docs/_static/label/freebsd.png deleted file mode 100644 index 7b2e0c4..0000000 Binary files a/docs/_static/label/freebsd.png and /dev/null differ diff --git a/docs/_static/label/gentoo.png b/docs/_static/label/gentoo.png deleted file mode 100644 index 164aed8..0000000 Binary files a/docs/_static/label/gentoo.png and /dev/null differ diff --git a/docs/_static/label/osx.png b/docs/_static/label/osx.png deleted file mode 100644 index 10e4180..0000000 Binary files a/docs/_static/label/osx.png and /dev/null differ diff --git a/docs/_static/label/python_package_index.png b/docs/_static/label/python_package_index.png deleted file mode 100644 index e33ff2b..0000000 Binary files a/docs/_static/label/python_package_index.png and /dev/null differ diff --git a/docs/_static/label/redhat.png b/docs/_static/label/redhat.png deleted file mode 100644 index d2614db..0000000 Binary files a/docs/_static/label/redhat.png and /dev/null differ diff --git a/docs/_static/label/resources/archlinux.xcf b/docs/_static/label/resources/archlinux.xcf deleted file mode 100644 index 7b8da17..0000000 Binary files a/docs/_static/label/resources/archlinux.xcf and /dev/null differ diff --git a/docs/_static/label/resources/debian.xcf b/docs/_static/label/resources/debian.xcf deleted file mode 100644 index 35a5ff7..0000000 Binary files a/docs/_static/label/resources/debian.xcf and /dev/null differ diff --git a/docs/_static/label/resources/fedora.xcf b/docs/_static/label/resources/fedora.xcf deleted file mode 100644 index 97e4c70..0000000 Binary files a/docs/_static/label/resources/fedora.xcf and /dev/null differ diff --git a/docs/_static/label/resources/freebsd.xcf b/docs/_static/label/resources/freebsd.xcf deleted file mode 100644 index 7dcfa98..0000000 Binary files a/docs/_static/label/resources/freebsd.xcf and /dev/null differ diff --git a/docs/_static/label/resources/gentoo.xcf b/docs/_static/label/resources/gentoo.xcf deleted file mode 100644 index eee000e..0000000 Binary files a/docs/_static/label/resources/gentoo.xcf and /dev/null differ diff --git a/docs/_static/label/resources/osx.xcf b/docs/_static/label/resources/osx.xcf deleted file mode 100644 index 5eab942..0000000 Binary files a/docs/_static/label/resources/osx.xcf and /dev/null differ diff --git a/docs/_static/label/resources/python_package_index.xcf b/docs/_static/label/resources/python_package_index.xcf deleted file mode 100644 index 4c9c30e..0000000 Binary files a/docs/_static/label/resources/python_package_index.xcf and /dev/null differ diff --git a/docs/_static/label/resources/redhat.xcf b/docs/_static/label/resources/redhat.xcf deleted file mode 100644 index 2002d66..0000000 Binary files a/docs/_static/label/resources/redhat.xcf and /dev/null differ diff --git a/docs/_static/label/resources/slackware.xcf b/docs/_static/label/resources/slackware.xcf deleted file mode 100644 index 52fdc38..0000000 Binary files a/docs/_static/label/resources/slackware.xcf and /dev/null differ diff --git a/docs/_static/label/resources/source_repository.xcf b/docs/_static/label/resources/source_repository.xcf deleted file mode 100644 index 5a491c1..0000000 Binary files a/docs/_static/label/resources/source_repository.xcf and /dev/null differ diff --git a/docs/_static/label/resources/ubuntu.xcf b/docs/_static/label/resources/ubuntu.xcf deleted file mode 100644 index 18e1643..0000000 Binary files a/docs/_static/label/resources/ubuntu.xcf and /dev/null differ diff --git a/docs/_static/label/slackware.png b/docs/_static/label/slackware.png deleted file mode 100644 index 6888a15..0000000 Binary files a/docs/_static/label/slackware.png and /dev/null differ diff --git a/docs/_static/label/source_repository.png b/docs/_static/label/source_repository.png deleted file mode 100644 index df29a1f..0000000 Binary files a/docs/_static/label/source_repository.png and /dev/null differ diff --git a/docs/_static/label/ubuntu.png b/docs/_static/label/ubuntu.png deleted file mode 100644 index 9b66bcf..0000000 Binary files a/docs/_static/label/ubuntu.png and /dev/null differ diff --git a/docs/_static/logo.png b/docs/_static/logo.png deleted file mode 100644 index 30f1b6c..0000000 Binary files a/docs/_static/logo.png and /dev/null differ diff --git a/docs/_static/logo_orig.png b/docs/_static/logo_orig.png deleted file mode 100644 index 2844b0a..0000000 Binary files a/docs/_static/logo_orig.png and /dev/null differ diff --git a/docs/_static/section/download/archlinux.png b/docs/_static/section/download/archlinux.png deleted file mode 100644 index 430d5db..0000000 Binary files a/docs/_static/section/download/archlinux.png and /dev/null differ diff --git a/docs/_static/section/download/debian.png b/docs/_static/section/download/debian.png deleted file mode 100644 index 659dc8d..0000000 Binary files a/docs/_static/section/download/debian.png and /dev/null differ diff --git a/docs/_static/section/download/fedora.png b/docs/_static/section/download/fedora.png deleted file mode 100644 index 30d2062..0000000 Binary files a/docs/_static/section/download/fedora.png and /dev/null differ diff --git a/docs/_static/section/download/freebsd.png b/docs/_static/section/download/freebsd.png deleted file mode 100644 index cec7774..0000000 Binary files a/docs/_static/section/download/freebsd.png and /dev/null differ diff --git a/docs/_static/section/download/gentoo.png b/docs/_static/section/download/gentoo.png deleted file mode 100644 index c96e01c..0000000 Binary files a/docs/_static/section/download/gentoo.png and /dev/null differ diff --git a/docs/_static/section/download/git.png b/docs/_static/section/download/git.png deleted file mode 100644 index 529aa0f..0000000 Binary files a/docs/_static/section/download/git.png and /dev/null differ diff --git a/docs/_static/section/download/git_alt.png b/docs/_static/section/download/git_alt.png deleted file mode 100644 index 88e399e..0000000 Binary files a/docs/_static/section/download/git_alt.png and /dev/null differ diff --git a/docs/_static/section/download/osx.png b/docs/_static/section/download/osx.png deleted file mode 100644 index bb9caca..0000000 Binary files a/docs/_static/section/download/osx.png and /dev/null differ diff --git a/docs/_static/section/download/pypi.png b/docs/_static/section/download/pypi.png deleted file mode 100644 index 5fd55b7..0000000 Binary files a/docs/_static/section/download/pypi.png and /dev/null differ diff --git a/docs/_static/section/download/redhat.png b/docs/_static/section/download/redhat.png deleted file mode 100644 index 7300b91..0000000 Binary files a/docs/_static/section/download/redhat.png and /dev/null differ diff --git a/docs/_static/section/download/resources/fedora.svg b/docs/_static/section/download/resources/fedora.svg deleted file mode 100644 index 8c9cbd6..0000000 --- a/docs/_static/section/download/resources/fedora.svg +++ /dev/null @@ -1,74 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" standalone="no"?> -<!-- Created with Inkscape (http://www.inkscape.org/) by Marsupilami --> - -<svg - xmlns:dc="http://purl.org/dc/elements/1.1/" - xmlns:cc="http://creativecommons.org/ns#" - xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" - xmlns:svg="http://www.w3.org/2000/svg" - xmlns="http://www.w3.org/2000/svg" - xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" - xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" - version="1.0" - width="1024" - height="324" - viewBox="-1.77184308 -1.77184308 197.90104616 62.60512216" - id="svg2870" - inkscape:version="0.48.1 r9760" - sodipodi:docname="Fedora_logo_and_wordmark.svg" - inkscape:export-filename="/home/atagar/Desktop/fedora.png" - inkscape:export-xdpi="57.099247" - inkscape:export-ydpi="57.099247"> - <metadata - id="metadata10"> - rdf:RDF - <cc:Work - rdf:about=""> - dc:formatimage/svg+xml</dc:format> - <dc:type - rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> - dc:title</dc:title> - </cc:Work> - </rdf:RDF> - </metadata> - <sodipodi:namedview - pagecolor="#ffffff" - bordercolor="#666666" - borderopacity="1" - objecttolerance="10" - gridtolerance="10" - guidetolerance="10" - inkscape:pageopacity="0" - inkscape:pageshadow="2" - inkscape:window-width="668" - inkscape:window-height="480" - id="namedview8" - showgrid="false" - inkscape:zoom="0.45996094" - inkscape:cx="801.51734" - inkscape:cy="162" - inkscape:window-x="0" - inkscape:window-y="25" - inkscape:window-maximized="0" - inkscape:current-layer="svg2870" /> - <defs - id="defs2872" /> - <path - inkscape:connector-curvature="0" - id="path3584" - style="fill:#072b61;fill-opacity:1;fill-rule:nonzero;stroke:none" - d="M 194.35736,16.449737 C 194.35736,7.3649625 186.99245,0 177.90779,0 168.8271,0 161.46537,7.3587875 161.45876,16.43815 l -5e-4,-5.38e-4 0,12.729488 5e-4,5.37e-4 c 0.005,2.0615 1.67683,3.730388 3.73966,3.730388 l 0.0179,-5.25e-4 9.9e-4,5.25e-4 12.69702,0 c 9.08175,-0.0034 16.44297,-7.365788 16.44297,-16.448288" /> - <path - inkscape:connector-curvature="0" - id="path3562" - style="fill:#0a57a4;fill-opacity:1;fill-rule:nonzero;stroke:none" - d="m 182.75,3.90625 c -4.26397,10e-8 -7.71875,3.4548375 -7.71875,7.71875 l 0,4.09375 -4.09375,0 c -4.26396,0 -7.71875,3.423888 -7.71875,7.6875 -1e-5,4.263838 3.45479,7.71875 7.71875,7.71875 4.26373,1e-6 7.71875,-3.454912 7.71875,-7.71875 l 0,-4.09375 4.09375,0 c 4.26369,1e-6 7.71875,-3.423663 7.71875,-7.6875 0,-4.263912 -3.45506,-7.71875 -7.71875,-7.71875 z m 0,3.625 c 2.25071,2e-7 4.09375,1.842775 4.09375,4.09375 0,2.250363 -1.84304,4.09375 -4.09375,4.09375 l -0.0312,0 -3.46875,0 c -0.31826,0 -0.59375,-0.276063 -0.59375,-0.59375 l 0,-3.5 c 0.004,-2.2480751 1.84598,-4.09375 4.09375,-4.09375 z m -11.8125,11.78125 3.5,0 c 0.31773,1e-6 0.59375,0.244663 0.59375,0.5625 l 0,3.53125 c -0.003,2.247326 -1.84571,4.09375 -4.09375,4.09375 -2.25041,1e-6 -4.09375,-1.843388 -4.09375,-4.09375 0,-2.25075 1.84334,-4.09375 4.09375,-4.09375 z" - sodipodi:nodetypes="sscsssscssscsscsscccssscsss" /> - <path - inkscape:connector-curvature="0" - id="path3588" - style="fill:#ffffff;fill-opacity:1;fill-rule:nonzero;stroke:none" - d="m 175.01713,15.7113 0,-4.086387 0,-0.0053 c 0,-4.263913 3.45636,-7.720338 7.72033,-7.720338 0.64712,0 1.10663,0.072625 1.7058,0.2295625 0.87288,0.2287375 1.58589,0.9440625 1.58643,1.7769625 2.4e-4,1.00655 -0.73035,1.7381375 -1.82225,1.7381375 -0.5204,0 -0.70824,-0.099563 -1.47026,-0.099563 -2.24777,0 -4.07055,1.82045 -4.07449,4.0685245 l 0,3.522563 0,5.37e-4 c 0,0.317688 0.25716,0.575338 0.57542,0.575338 l 0.002,0 2.67567,0 c 0.99728,0 1.8022,0.797875 1.80304,1.797475 0,1.00045 -0.80603,1.7968 -1.80304,1.7968 l -3.25271,0 0,4.10385 0,0.0054 c 0,4.2633 -3.45661,7.720225 -7.72034,7.720225 -0.64685,0 -1.10662,-0.07299 -1.70525,-0.2295 -0.8732,-0.228425 -1.58673,-0.944325 -1.58698,-1.776925 0,-1.0065 0.73065,-1.738475 1.82252,-1.738475 0.51985,0 0.70849,0.09988 1.46971,0.09988 2.24804,0 4.07135,-1.82095 4.07505,-4.0688 l 0,-3.5408 c 0,-0.3173 -0.25771,-0.574338 -0.57545,-0.574338 l -0.002,0 -2.6757,-5.37e-4 c -0.99726,0 -1.80297,-0.795588 -1.80297,-1.795725 -5.7e-4,-1.006325 0.8 1415,-1.79855 1.82221,-1.79855 l 3.23323,0" /> -</svg> -<!-- version: 20080810, original size: 194.35736 59.061436, border: 3% --> - diff --git a/docs/_static/section/download/slackware.png b/docs/_static/section/download/slackware.png deleted file mode 100644 index 324e046..0000000 Binary files a/docs/_static/section/download/slackware.png and /dev/null differ diff --git a/docs/_static/section/download/ubuntu.png b/docs/_static/section/download/ubuntu.png deleted file mode 100644 index 90a9c6e..0000000 Binary files a/docs/_static/section/download/ubuntu.png and /dev/null differ diff --git a/docs/_static/section/screenshots/acs_display_failure.png b/docs/_static/section/screenshots/acs_display_failure.png deleted file mode 100644 index cd44aa8..0000000 Binary files a/docs/_static/section/screenshots/acs_display_failure.png and /dev/null differ diff --git a/docs/_static/section/screenshots/acs_display_failure_full.png b/docs/_static/section/screenshots/acs_display_failure_full.png deleted file mode 100644 index 48aff76..0000000 Binary files a/docs/_static/section/screenshots/acs_display_failure_full.png and /dev/null differ diff --git a/docs/_static/section/screenshots/config.png b/docs/_static/section/screenshots/config.png deleted file mode 100644 index bfc8b12..0000000 Binary files a/docs/_static/section/screenshots/config.png and /dev/null differ diff --git a/docs/_static/section/screenshots/config_full.png b/docs/_static/section/screenshots/config_full.png deleted file mode 100644 index d04f412..0000000 Binary files a/docs/_static/section/screenshots/config_full.png and /dev/null differ diff --git a/docs/_static/section/screenshots/connections.png b/docs/_static/section/screenshots/connections.png deleted file mode 100644 index 8140b16..0000000 Binary files a/docs/_static/section/screenshots/connections.png and /dev/null differ diff --git a/docs/_static/section/screenshots/connections_full.png b/docs/_static/section/screenshots/connections_full.png deleted file mode 100644 index 5f5f2ad..0000000 Binary files a/docs/_static/section/screenshots/connections_full.png and /dev/null differ diff --git a/docs/_static/section/screenshots/interpreter.png b/docs/_static/section/screenshots/interpreter.png deleted file mode 100644 index 3a09ad4..0000000 Binary files a/docs/_static/section/screenshots/interpreter.png and /dev/null differ diff --git a/docs/_static/section/screenshots/interpreter_full.png b/docs/_static/section/screenshots/interpreter_full.png deleted file mode 100644 index 045ebc0..0000000 Binary files a/docs/_static/section/screenshots/interpreter_full.png and /dev/null differ diff --git a/docs/_static/section/screenshots/main.png b/docs/_static/section/screenshots/main.png deleted file mode 100644 index db8e6cd..0000000 Binary files a/docs/_static/section/screenshots/main.png and /dev/null differ diff --git a/docs/_static/section/screenshots/main_full.png b/docs/_static/section/screenshots/main_full.png deleted file mode 100644 index ba1d982..0000000 Binary files a/docs/_static/section/screenshots/main_full.png and /dev/null differ diff --git a/docs/_static/section/screenshots/torrc.png b/docs/_static/section/screenshots/torrc.png deleted file mode 100644 index fdd822e..0000000 Binary files a/docs/_static/section/screenshots/torrc.png and /dev/null differ diff --git a/docs/_static/section/screenshots/torrc_full.png b/docs/_static/section/screenshots/torrc_full.png deleted file mode 100644 index 3263a47..0000000 Binary files a/docs/_static/section/screenshots/torrc_full.png and /dev/null differ diff --git a/docs/_static/section/screenshots/vidalia.png b/docs/_static/section/screenshots/vidalia.png deleted file mode 100644 index 5e10610..0000000 Binary files a/docs/_static/section/screenshots/vidalia.png and /dev/null differ diff --git a/docs/_static/section/screenshots/vidalia_full.png b/docs/_static/section/screenshots/vidalia_full.png deleted file mode 100644 index 3e13855..0000000 Binary files a/docs/_static/section/screenshots/vidalia_full.png and /dev/null differ diff --git a/docs/_static/style.css b/docs/_static/style.css deleted file mode 100644 index fe9db20..0000000 --- a/docs/_static/style.css +++ /dev/null @@ -1,17 +0,0 @@ -div.literal-block-wrapper { - padding: 0; -} - -span.caption-text { - float: right; -} - -span.red { - color: red; - font-weight: bold; -} - -span.green { - color: green; - font-weight: bold; -} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html deleted file mode 100644 index 6e428a5..0000000 --- a/docs/_templates/layout.html +++ /dev/null @@ -1,80 +0,0 @@ -{# - haiku/layout.html - ~~~~~~~~~~~~~~~~~ - - Sphinx layout template for the haiku theme. - - :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. -#} -{% extends "basic/layout.html" %} - -{% set css_files = css_files + ['_static/style.css'] %} - -{# do not display relbars #} -{% block relbar1 %}{% endblock %} -{% block relbar2 %}{% endblock %} - -{% macro nav() %} - <p> - {%- block haikurel1 %} - {%- endblock %} - - <ul id="navbar"> - <li><a href="{{ pathto(master_doc) }}">Home</a></li> - <li><a href="{{ pathto('screenshots') }}">Screenshots</a></li> - <li><a href="https://trac.torproject.org/projects/tor/wiki/doc/nyx">Development</a> - <ul> - <li><a href="{{ pathto('faq') }}">FAQ</a></li> - <li><a href="{{ pathto('change_log') }}">Change Log</a></li> - <li><a href="https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs">Bug Tracker</a></li> - <li><a href="https://trac.torproject.org/projects/tor/wiki/doc/nyx">Wiki</a></li> - <li><a href="{{ pathto('download') }}">Download</a></li> - </ul> - </li> - <li><a href="{{ pathto('faq') }}#where-can-i-get-help">Contact</a> - <ul> - <li><a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev">Email List</a></li> - <li><a href="https://www.torproject.org/about/contact.html.en#irc">IRC</a></li> - <li><a href="https://www.atagar.com/contact/">Author</a></li> - </ul> - </li> - </ul> - - {%- block haikurel2 %} - {%- endblock %} - </p> -{% endmacro %} - -{% block content %} - <div class="header"> - {%- block haikuheader %} - {%- if theme_full_logo != "false" %} - <a href="{{ pathto('index') }}"> - <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/> - </a> - {%- else %} - {%- if logo -%} - <img class="rightlogo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/> - {%- endif -%} - <h1 class="heading"><a href="{{ pathto('index') }}"> - <span>{{ shorttitle|e }}</span></a></h1> - <h2 class="heading"><span>{{ title|striptags|e }}</span></h2> - {%- endif %} - {%- endblock %} - </div> - <div class="topnav"> - {{ nav() }} - </div> - <div class="content"> - {#{%- if display_toc %} - <div id="toc"> - <h3>Table Of Contents</h3> - {{ toc }} - </div> - {%- endif %}#} - {% block body %}{% endblock %} - </div> - <div class="bottomnav"> - </div> -{% endblock %} diff --git a/docs/change_log.rst b/docs/change_log.rst deleted file mode 100644 index e70f0db..0000000 --- a/docs/change_log.rst +++ /dev/null @@ -1,77 +0,0 @@ -Change Log -========== - -The following is a log of all user-facing changes to Nyx, both released and -unreleased. For a monthly report on work being done see my `development log -http://blog.atagar.com/`_. - -* :ref:`versioning` -* :ref:`unreleased` -* `Version 1.x <change_log_legacy.html>`_ - -.. _versioning: - -Versioning ----------- - -As of the 2.x release Nyx uses `semantic versioning http://semver.org/`_, -which means that **versions consist of three numbers** (such as '**1.2.4**'). -These are used to convey the kind of backward compatibility a release has... - - * The first value is the **major version**. This changes infrequently, and - indicates that backward incompatible changes have been made (such as the - removal of deprecated functions). - - * The second value is the **minor version**. This is the most common kind of - release, and denotes that the improvements are backward compatible. - - * The third value is the **patch version**. When a Nyx release has a major - issue another release is made which fixes just that problem. These do not - contain substantial improvements or new features. This value is sometimes - left off to indicate all releases with a given major/minor version. - -Prior to version 2.x nyx did not follow any particular versioning scheme. - -.. _unreleased: - -Unreleased ----------- - -The following are only available within Nyx's `git repository -<download.html>`_. - -From a user perspective little has changed, but this release is nothing less -than a complete rewrite of our codebase. This adds long overdue **support for -python 3.x**, test coverage, and migrate from TorCtl to `Stem -https://stem.torproject.org/`_. - -Python 2.5 is no longer supported, but hopefully by now nobody will miss it. ;) - - * **Startup** - - * Startup is several seconds faster when ran for the first time - - * **Graph** - - * Graph prepopulation no longer requires shifting to 15 minute intervals - - * **Connections** - - * Connections are now shown despite DisableDebuggerAttachment - * Support for showing IPv6 connections - - * **Logging** - - * Order of magnitude faster log deduplication - - * **Curses** - - * Interface continues to update while awaiting user input - -Version 1.x ------------ - -Prior to its 2.x release Nyx went under the name of "**arm**". This series was -under active development 2009-2012. Changelog for the series is available `here -<change_log_legacy.html>`_. - diff --git a/docs/change_log_legacy.rst b/docs/change_log_legacy.rst deleted file mode 100644 index 3959d3e..0000000 --- a/docs/change_log_legacy.rst +++ /dev/null @@ -1,803 +0,0 @@ -Version 1.x Change Log ----------------------- - -Prior to its 2.x release Nyx went under the name of "**arm**". This series was -under active development 2009-2012. - -* :ref:`version_1.4.5` -* :ref:`version_1.4.4` -* :ref:`version_1.4.3` -* :ref:`version_1.4.2` -* :ref:`version_1.4.1` -* :ref:`version_1.4.0` -* :ref:`version_1.3.7` -* :ref:`version_1.3.6` -* :ref:`version_1.3.5` -* :ref:`version_1.3.4` -* :ref:`version_1.3.3` -* :ref:`version_1.3.2` -* :ref:`version_1.3.1` -* :ref:`version_1.3.0` -* :ref:`version_1.2.2` -* :ref:`version_1.2.1` -* :ref:`version_1.2.0` -* :ref:`version_1.1.3` -* :ref:`version_1.1.2` -* :ref:`version_1.1.1` -* :ref:`version_1.1.0` - -.. _version_1.4.5: - -Version 1.4.5 (April 28th, 2012) --------------------------------- - -Software isn't perfect and Nyx is no exception. This is a bugfix release that -corrects most issues that users have reported over the last several months. -This did not include new features, but did have several changes that were -important for continued interoperability with tor. - - * **Startup** - - * Check auth cookie is 32 bytes before reading (:trac:`4305`) - * Crash when tor log file contains leap year dates (:trac:`5265`) - * Crash when using unrecognized authentication methods like 'SAFECOOKIE' - - * **Logging** - - * Path issue when saving snapshot of the logs (`issue http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=646080`_) - - * **Connections** - - * Notify when DisableDebuggerAttachment prevents connection lookups - * Better validation of circuit-staus output (:trac:`5267`) - * Help information for 'enter' mislabeled (:trac:`4621`) - * Circuits failed to show when connection information was unavailable - - * **Torrc** - - * Validation was case sensitive (:trac:`4601`) - * Misleading DirReqStatistics warnings with new tor versions (:trac:`4237`) - - * **Curses** - - * Major terminal glitches related to the import of the readline module - * Config option to work around ACS failures - - * **Cross-Platform Support** - - * **OSX/BSD:** support for pwd lookups (:trac:`4236`) - * **OSX/BSD:** ps checks couldn't detect tor process - * **OpenBSD:** only use lsof for connecion lookups - * **Linux:** proc utils didn't account for big-endian architectures (:trac:`4777`) - * **Debian:** misleading warning about default Logging value (:trac:`4602`) - * **RedHat:** specify python verion in rpm dependencies - -.. _version_1.4.4: - -Version 1.4.4 (September 25th, 2011) ------------------------------------- - -Besides the normal bug fixes and minor features, this release introduces the -**control interpreter**. This is a new prompt that gives raw control port -access with tab completion, history scrollback, and irc-style command. - - * **Startup** - - * ControlSocket support (:trac:`3638`) - * Notify when tor or nyx are running as root - * Take chroot into consideration for auth cookie path - * Don't start wizard when there's a tor process running, even if we can't connect to it - * Try all authentication methods rather than just the first (:trac:`3958`) - - * **Graph** - - * Crash when pausing if we showed accounting stats - - * **Logging** - - * Skip reading from malformed tor log files - * Unable to log GUARD events - - * **Connections** - - * Added dialogs with exit usage by port and guard/bridge usage by locale - * Crash when shutting down while relay addresses are resolved - * Crash when CIRC event occured while caching attached relays - - * **Configuration Editor** - - * Optional system wide torrc integration (:trac:`3629`) - * We wrote a blank torrc when 'GETINFO config-text' was unavailable - * Hotkey for saving the torrc conflicted with the relay setup wizard - * Crash when pressing 'enter' if never attached to tor - - * **Wizard** - - * Quit wizard when the user presses 'q' rather than just esc (:trac:`3995`) - - * **Curses** - - * Force manual redraw when user presses ctrl+L (:trac:`2830`) - * Quitting could cause unclean curses shutdown - * Periodically redraw content to prevent terminal issues from persisting - - * **Website and Manual** - - * Moved downloads to archive.torproject.org for ssl - * Incorrect nyxrc path in man page - - * **Hotfix release** (September 29th, 2011) corrected the following... - - * Crash when esc was pressed in the interpreter prompt (:trac:`4098`) - * Deduplicationg couple common log messages (:trac:`4096`) - * Ctrl+L redraw wasn't always being triggered (:trac:`2830`) - * Dropped gtk/cagraph requirements - -.. _version_1.4.3: - -Version 1.4.3 (July 16th, 2011) -------------------------------- - -This completes the codebase refactoring that's been a year in the works and -provides numerous performance and usability improvements. Most notably a -**setup wizard for new relays** and **menu interface**. This release also -includes gui prototype, performance improvements, and support for Mac OSX. - - * **Startup** - - * Renamed our process from "python src/starter.py" to "nyx" - * Moved connection negotiation into torctl (:trac:`3409`) - * Avoid excessive torctl memory allocation, lowering memory usage by 2.5 MB (12%) (:trac:`3406`) - * More descriptive controller password prompt - * Crash when a sighup crashes tor (:trac:`1329`) - * Crash from unjoined threads during shutdown - * Crash when pressing ctrl+c due to improper daemon shutdown - * Crash when using the --debug argument with old tor versions - * Crash when tor's socks port was used rather than the control port (:trac:`2580`) - - * **Header** - - * Requests a new identity when the user presses 'n' - * Option to reconnect when tor's restarted - * Provides file descriptor usage when tor is running out - * Dropped file descriptor popup (both unused and inaccurate) - * Indicate when tor's shut down in client mode - - * **Graph** - - * Pre-populates total bandwidth uploaded/downloaded - * More intuitive mode toggling for resizing the graph - * Intermediate graph bounds inaccurate or missing - - * **Connections** - - * Reintroduced descriptor popup - * Provide nickname for circuit connections - * Shut down torctl zombie connections to the control port (:trac:`2812`) - * Misparsed circuit paths for tor versions prior to 0.2.2.1 - * Crash when pressing enter on a blank connection page (:trac:`3128`) - * Crash when querying locales if geoip information was unavailable - - * **Configuration Editor** - - * Using SAVECONF rather than writing torrc directly - * Edited config entries didn't display new value - * Using extra horizontal space for the configuration values - * Fallback configuration descriptions weren't being installed - * Misparsed config option types for old tor versions - - * **Torrc** - - * Validation false positives for autogenerated Nickname values - - * **Curses** - - * Option to exclude panels from the interface - * Option to override all displayed color - * Speeding nyx's startup time from 0.84s to 0.14s (83% improvement by fetching connections in background) - * Speeding nyx's shutdown time form ~1s to instantaneous (:trac:`2412`) - * Display was cropped by an extra cell - * Closing all message prompts when a key is pressed - * Crash when cropping whitespace-only strings - - * **Manual** - - * Hardcoded home path rather than ~ - - * **Website** - - * Moved nyx's codebase to git, with helper scripts to replace svn:externals and export - - * **Cross-Platform Support** - - * **OSX:** tor's pid couldn't be resolved, breaking much of nyx - * **OSX:** only use lsof for connecion lookups - -.. _version_1.4.2: - -Version 1.4.2 (April 4th, 2011) -------------------------------- - -This release re-implements the connection panel. Besides maintainability, this -includes several features like circuit paths, application connections, and -better type identification. - - * **Startup** - - * Faster startup by lazy loading 'address => fingerprint' mappings - * Dropped warning suggesting users set FetchUselessDescriptors - * Failed connection attempts caused zombie connections (:trac:`2812`) - * nyxrc option 'startup.dataDirectory' didn't work - * Crash when using python 2.5 due to missing bin built-in - * Crash when family entries have a trailing comma (:trac:`2414`) - * Crash from uncaught OSError when making directories failed - * Crash joining with torctl thread during shutdown - * Crash citing 'syshook' during shutdown - - * **Header** - - * Displayed wrong address if changed since first started (:trac:`2776`) - - * **Graph** - - * Dropping use of the state file for bandwidth totals due to having just a day's worth of data - - * **Connections** - - * Listing active circuits - * Identifying connection applications (firefox, vidalia, etc) - * Identifying common port usage for exit connections - * Display 'local -> internal -> external' address when there's room - * Address order inverted for SOCKS and CONTROL connections - * Better identifying client and directory connections - * Better disambiguating multiple relays with the same address - * Better space utilization for a variety of screen sizes - * Detail popup no longer freezes the rest of the display - * Detail popup now uses the full screen width and is dynamically resizable - * Take DirServer and AlternateDirAuthority into account to determine authorities - * Didn't recognize 172.* address as a private IP range - * Renamed the 'APPLICATION' type to 'SOCKS' - * Crash due to unknown relay nicknames - - * **Configuration Editor** - - * Hiding infrequently used config options by default - * Better caching, reducing CPU use when scrolling by 40% - - * **Torrc** - - * Validation requires 'GETINFO config-text' from Tor verison 0.2.2.7 (:trac:`2501`) - * Line numbers for torrc issues were off by one - * Allowed sorting by 'is default' attribute - - * **Manual** - - * Instructions for setting up authentication in the readme - - * **Cross-Platform Support** - - * **BSD:** broken resolver availability checks caused connections to not show up for several seconds - - * **Hotfix release** (April 4th, 2011) - crash when parsing multiple spaces in the HiddenServicePort - * **Hotfix release** (April 6th, 2011) - installing missed new files - * **Hotfix release** (April 13th, 2011) - crash when requesting our flags failed - -.. _version_1.4.1: - -Version 1.4.1 (January 7th, 2011) ---------------------------------- - -Platform specific enhancements including BSD compatibility and greatly improved -performance on Linux. - - * **Startup** - - * '--debug' argument for dumping debugging information - * Centralizing nyx resources in ~/.nyx - * Expanding relative authentication cookie paths - * Startup forked rather than execed our process - * Crash with invlid paths including spaces and dashes - * Crash when text input fields shown with python 2.5 - - * **Header** - - * Displaying nyx's cpu usage - * Updating uptime each second - * More accurate measurement of tor cpu usage - - * **Logging** - - * No date dividers when scrollbars not present - - * **Connections** - - * Labeling use of our socks port as client connections - * Provide UDP connections to include DNS lookups - * Some resolvers failed when pid was unavailable - * Dropping locale for internal connections - * Skipping internal -> external address translation for private addresses - * Initially shown connections often lacked the pid - * Connection resolution failed when tor ran under a different name - * Crash when presenting an undefined nickname - - * **Configuration Editor** - - * Summary descriptions of config options - * Fallback manual information when tor's man page is unavailable - * Crash when querying hidden service parameters - - * **Torrc** - - * Reloading torrc contents when there's a sighup - * Validation false positives when GETCONF response has spaces - - * **Cross-Platform Support** - - * **Linux:** retrieving process information directly from proc, dramatically improving performance - * **BSD:** pid resolution via pgrep and sockstat - * **BSD:** connection resolution via sockstat, procstat, and lsof - * **BSD:** auto-detecting path prefixes for FreeBSD jails - - * **Hotfix release** (January 11th, 2011) corrected the following... - - * Including platform, python version, and nyx/tor configurations in debug dumps - * Crash when initial ps lookup fails - - * **Hotfix release** (January 12th, 2011) - properly parse ps results with decimal seconds - * **Hotfix release** (January 15th, 2011) - adding --docPath argument to help Gentoo ebuilds (`issue https://bugs.gentoo.org/349792`_) - -.. _version_1.4.0: - -Version 1.4.0 (November 27th, 2010) ------------------------------------ - -**New page to manage tor's configuration**, along with several revisions in -preparation for being included in Debian. - - * **Startup** - - * Moved installation location to /usr/share/nyx - * Replaced deb/rpm build resources with helper scripts - * Removing autogenerated egg file from deb build - * Including dh_pysupport flag to recognize private python module - * Dropping references to the controller password after startup - * Continued running in a broken state after ctrl+c due to non-daemon threads - - * **Logging** - - * Added scrollbar and scrolling by displayed content rather than line numbers - * Disabling deduplications for long logs to avoid freezing interface - * Crash when displaying empty torrc contents - - * **Torrc** - - * Validation notice when tor's present configuration doesn't match the torrc - * Validation notice when torrc entry matches its default value - * Validation didn't recognize 'second' and 'byte' arguments - * Parsing multiline torrc entries supported in tor 0.2.2.17 - * Buggy scrolling when comments were stripped - - * **Curses** - - * Popups more resilient to the interface being resized - * Using curses.textpad to add support in text fields for arrow keys, emacs keybindings, etc - * Rounding error determining our scrollbar size - - * **Manual** - - * Incorrect man path for the sample nyxrc - - * **Hotfix release** (November 30th, 2010) - installer crashed creating temporary directory for compressed man page - -.. _version_1.3.7: - -Version 1.3.7 (October 6th, 2010) ---------------------------------- - -Expanded log panel, installer, and deb/rpm builds. - - * **Startup** - - * Installation and removal scripts - * Configurable path prefix for chroot jails - * Using PidFile to get the pid if available - * Dump stacktrace to /tmp when exceptions are raised while redrawing - * Crash if ORPort left unset - - * **Header** - - * Caching for static GETINFO parameter - * Drop irrelevant information when not running as a relay - - * **Graph** - - * Incremental y-axis measurements - * Option for graph resizing - * Measuring transfer rates in bits by default - * Use update interval that matches tor's state file when prepopulating - * Skip bandwidth prepopulation if not running as a relay - * Properly update bandwidth stats during sighup - * Race condition between heartbeat and first BW event - * Crash when displayed in especially wide screens - - * **Logging** - - * Dividers for the date, bordering events from the same day - * Deduplicating log entries - * Option to clear the event log - * Option for saving logged events, either as a snapshot or persistently - * Support cropping events based on time - * Redrawing with each event when at debug runlevel caused high cpu usage - * Notice if tor supports event types that nyx doesn't - * Better consolidation of identical runlevel labels - * Performance improvements for log preopulation, caching, etc - * Merging tor and nyx events by timestamp when prepopulating - * Regex filtering broken for multiline log entries - * Drop brackets if no events are being logged - - * **Connections** - - * Disabling DNS resolution to prevent leaking information to our resolvers - * Failed to handle family entries identified by nickname - - * **Torrc** - - * Failed to parse torrc files with tabs - * Remapping torrc aliases so GETCONF calls don't fail - * Checking torrc logging types was case sensitive - * Crash when ExitPolicy was undefined - - * **Curses** - - * Jumping to start/end of scrolling area when pressing home or end - * Refreshing after popups to make the interface more responsive - - * **Manual** - - * Created man page - - * **Cross-Platform Support** - - * **Linux:** scripts and resources for making debs and rpms - * **Debian:** change debian arch from any to all - - * **Hotfix release** (October 7th, 2010) - crash with TypeError in the graph panel - -.. _version_1.3.6: - -Version 1.3.6 (June 7th, 2010) ------------------------------- - -Performance improvements and a few nice features. This improves the refresh -rate (coinciding with a drop of cpu usage) from 30ms to 4ms, an 87% -improvement. - - * **Startup** - - * Faster quitting by no longer waiting on sleeping threads - * Caching commonly fetched relay information (fingerprint, descriptor, etc) - * Systems util to standardize usage, add caching, prevent stdout leakage, etc - * Optionally fetch settings from a nyxrc file - * Wrapper for TorCtl providing singleton accessor and better API - * Drop support for the '-p' argument for security reasons - * Crash if torctl reports TorCtlClosed before the first refresh - - * **Header** - - * Support reattaching when tor's stopped then restarted - * Notify when tor's disconnected - * Better handling of tiny displays - * Better caching and background updating - - * **Graph** - - * Prepopulate bandwidth information from stat file when available - * Provide observed and measured bandwidth stats - * Option to restrict graph bounds to local minima and maxima - * Account for MaxAdvertisedBandwidth in the effective bandwidth rate - * Better caching and reduced redraw rate - - * **Connections** - - * Suspend connection resolution when tor's stopped - * Don't initialize while in blind mode - * ss resolution didn't specifying use of numeric ports - * Issue defaulting connection resolver to one we predetermined to be available - * Crash when trying to resolve addresses without network connectivity - * Crash due to unjoined connection resolution thread when quitting - -.. _version_1.3.5: - -Version 1.3.5 (April 8th, 2010) -------------------------------- - -Handful of small fixes amid codebase refactoring. - - * **Startup** - - * Issue resets via RELOAD signal rather than SIGHUP - * Crash due to unexpected None values when calling GETCONF - - * **Logging** - - * Panel sometimes drew itself before properly positioned while starting up - - * **Connections** - - * Added lsof and ss connection resolvers - * Option for selecting mode of resolution - * Reduce connection resolution rate if calls are burdensome - * Optional dns resolution via socket module (disabled by default due to worse performance) - - * **Curses** - - * Crash when use_default_colors() fails - * Help keys weren't consistently bolded - -.. _version_1.3.4: - -Version 1.3.4 (March 7th, 2010) -------------------------------- - -Bugfix bundle for a handful of issues. - - * **Startup** - - * Crash when user pressed ctrl+c due to uncaught KeyboardInterrupt - - * **Header** - - * Multi-line exit policies weren't interpreted correctly - - * **Connections** - - * Crash when consensus couldn't be retrieved - - * **Torrc** - - * Display bug when stripping comments if torrc is longer than the screen - * Stripping didn't include inline comments - * Validation failed for some CSV values like ExitPolicy - - * **Cross-Platform Support** - - * **Debian:** file descriptor limit estimation incorrect - - * **Hotfix release** (March 9th, 2010) - crash while starting up processing family connections - * **Hotfix release** (April 7th, 2010) - sensitive data not scrubbed for inbound connections - -.. _version_1.3.3: - -Version 1.3.3 (February 27th, 2010) ------------------------------------ - -Handful of issues brought up on irc, most notably scrubbing the interface of -sensitive information. - - * **Startup** - - * Checking for curses built-ins before starting up - - * **Graph** - - * Added precision for bandwidth cap and burst - * Not resized properly during a sighup - - * **Connections** - - * Scrubbing sensitive client/exit information to address privacy concerns - * Showing external address rather than local nat - - * **Manual** - - * Providing file descriptions in the README - * Crash due to missing sockset and torctl imports - -.. _version_1.3.2: - -Version 1.3.2 (February 14th, 2010) ------------------------------------ - -Small bugfix bundle. - - * **Header** - - * Couple system commands weren't suppressing stderr - * Didn't account for ORListenAddress in the address we displayed - - * **Graph** - - * Mishandling DST for accounting's 'Time to reset' - - * **Manual** - - * Include copy of the GPL - - * **Curses** - - * Crash when too small for scrollbars to be drawn - -.. _version_1.3.1: - -Version 1.3.1 (February 7th, 2010) ----------------------------------- - -Small bugfix bundle, mostly focused on improving initialization. - - * **Startup** - - * Use PROTOCOLINFO to autodetect supported authentication and cookie location - * Added the '--blind' argument to prevent connection lookups - * Added the '--event' argument to select events to log by character flags - - * **Logging** - - * Condense event labels for runlevel ranges - -.. _version_1.3.0: - -Version 1.3.0 (November 29th, 2009) ------------------------------------ - -Small bugfix bundle. - - * **Startup** - - * Commands can be invoked directly from the help popup - * Suppress torctl startup issues from going to stdout - - * **Header** - - * Truncating version if too long - * Error messaging when file descriptor dialog fails - - * **Connections** - - * Offset glitch when scrollbar is visible - * Drop family entries if control port connection is closed - -.. _version_1.2.2: - -Version 1.2.2 (November 8th, 2009) ----------------------------------- - -Small bugfix bundle before starting a new job. - - * **Header** - - * File descriptor popup providing stats and a scrollable listing - * Crash when cleaning up hostname cache - - * **Connections** - - * Include family relays in the connection listing - * Stretching connection lines to fill the full screen - - * **Torrc** - - * Warning if torrc fails to load - * Validation usually weren't detecting duplicates - -.. _version_1.2.1: - -Version 1.2.1 (October 21st, 2009) ----------------------------------- - -Torrc validation, improved event logging, and more. - - * **Startup** - - * Crash due to improperly closing torctl when quitting - * Crash due to uncaught TorCtlClosed exceptions - - * **Header** - - * Notice when control port is closed - * Progress bar when resolving a batch of hostnames - * Information left inaccurate after sighup - - * **Connections** - - * Incorrect connection counts when paused - * Noisy netstat and geoip failures when tor quit - * Sorting broken when unpaused - - * **Torrc** - - * Verify that the torrc matches tor's actual state - * Check for torrc entries that are irrelevant due to being duplicates - - * **Logging** - - * Support logging nyx and torctl events - * Only prepopulate events from this tor instance - * Limit number of prepopulated entries to prevent long startup time - -.. _version_1.2.0: - -Version 1.2.0 (October 16th, 2009) ----------------------------------- - -Small bugfix bundle. - - * **Startup** - - * Ask for confirmation when quitting - - * **Logging** - - * Prepopulation using tor's log file - * Support multi-line log messages - - * **Connections** - - * Connection times became inaccurate when paused or not visible - * Crash due to connection cache when paused - -.. _version_1.1.3: - -Version 1.1.3 (September 28th, 2009) ------------------------------------- - -Small bugfix bundle. - - * **Startup** - - * Fall back to ps to determine tor's pid - - * **Connections** - - * Query connections in the background rather than as part of rendering - - * **Torrc** - - * Expand relative torrc paths - -.. _version_1.1.2: - -Version 1.1.2 (September 27th, 2009) ------------------------------------- - -Small bugfix bundle. - - * **Graph** - - * Reloading static information after SIGHUP - - * **Manual** - - * Added a changelog - - * **Cross-Platform Support** - - * **OSX/BSD:** crash when system calls failed - -.. _version_1.1.1: - -Version 1.1.1 (September 23rd, 2009) ------------------------------------- - -Small bugfix bundle. - - * **Startup** - - * Notify if python version is incompatible - * Added the '--version' argument to help with bug reports - - * **Graph** - - * Didn't account for RelayBandwidthRate/Burst in effective bandwidth - - * **Connections** - - * Provide additional connection information when room's available - * Identifying directory connections - * Preserving old listing when netstat fails - -.. _version_1.1.0: - -Version 1.1.0 (September 6th, 2009) ------------------------------------ - -Initial release of Nyx. - diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 5221073..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,239 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Nyx documentation build configuration file, created by -# sphinx-quickstart on Thu May 31 09:56:13 2012. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. - -sys.path.insert(0, os.path.abspath('..')) -sys.path.append(os.path.abspath('.')) -# -- General configuration ----------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.1' # required for the sphinx-apidoc command - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'roles'] - -autodoc_member_order = 'bysource' -autodoc_default_flags = ['members', 'show-inheritance', 'undoc-members'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -from nyx import __version__, __author__, __contact__ - -# Ignore the '-dev' version suffix. - -if __version__.endswith('-dev'): - __version__ = __version__[:-4] - -# General information about the project. -project = 'Nyx' -copyright = '2009, %s' % __author__ - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = __version__[:__version__.rfind(".")] -# The full version, including alpha/beta/rc tags. -release = __version__ - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - - -# -- Options for HTML output --------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -#html_theme = 'default' -html_theme = 'haiku' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# "<project> v<release> documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -html_short_title = 'Nyx' - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. - -html_logo = 'logo.png' - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. - -html_favicon = 'favicon.png' - -# 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -html_use_smartypants = False - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -html_show_sourcelink = False - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -html_show_sphinx = False - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -html_show_copyright = False - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Nyxdoc' - - -# -- Options for LaTeX output -------------------------------------------------- - -# The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). -latex_documents = [ - ('index', 'Nyx.tex', 'Nyx Documentation', - 'Damian Johnson', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Additional stuff for the LaTeX preamble. -#latex_preamble = '' - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output -------------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'Nyx', 'Nyx Documentation', - ['%s (%s)' % (__author__, __contact__)], 1) -] - -trac_url = 'https://trac.torproject.org/%7Bslug%7D' - -def skip_members(app, what, name, obj, skip, options): - if name in ('ATTRIBUTES', 'PARSER_FOR_LINE'): - return True # skip the descriptor's parser constants - -def setup(app): - app.connect('autodoc-skip-member', skip_members) diff --git a/docs/contents.rst b/docs/contents.rst deleted file mode 100644 index b2f2ec9..0000000 --- a/docs/contents.rst +++ /dev/null @@ -1,12 +0,0 @@ -Contents -======== - -.. toctree:: - :maxdepth: 2 - - change_log - change_log_legacy - download - faq - screenshots - diff --git a/docs/download.rst b/docs/download.rst deleted file mode 100644 index fa0cc60..0000000 --- a/docs/download.rst +++ /dev/null @@ -1,178 +0,0 @@ -Download -======== - -.. Image Sources: - - * PyPI - Source: http://www.python.org/community/logos/ - License: http://www.python.org/psf/trademarks - - * OSX - Source: IconArchive (http://www.iconarchive.com/show/papercut-social-icons-by-graphicloads/Apple-...) - Author: GraphicLoads, Papercut Social Icons - License: Freeware - - * Debian - Source: NuoveXT (http://nuovext.pwsp.net/) - Author: Alexandre Moore (http://sa-ki.deviantart.com/) - License: GPL v2 - File: NuoveXT/128x128/apps/debian-logo.png - - * Ubuntu - Source: http://logonoid.com/ubuntu-logo/ - Not quite sure of the license, probably covered by... - http://design.ubuntu.com/brand/ubuntu-logo - - * Fedora - Source: https://en.wikipedia.org/wiki/File:Fedora_logo_and_wordmark.svg - Author: Unknown - - * Red Hat - Source: NuoveXT (http://nuovext.pwsp.net/) - Author: Alexandre Moore (http://sa-ki.deviantart.com/) - License: GPL v2 - File: NuoveXT/128x128/apps/fedora.png - - * Gentoo - Source: https://www.gentoo.org/main/en/name-logo.xml - - * Arch Linux - Source: https://en.wikipedia.org/wiki/File:Archlinux-official-fullcolour.svg - - * Slackware - Source: NuoveXT (http://nuovext.pwsp.net/) - Author: Alexandre Moore (http://sa-ki.deviantart.com/) - License: GPL v2 - File: NuoveXT/128x128/apps/slackware.png - - * FreeBSD - Source: https://en.wikipedia.org/wiki/File:Freebsd_logo.svg - Author: Anton Gural - - * Git - Source: https://en.wikipedia.org/wiki/File:Git-logo.svg - Author: Jason Long - License: CC v3 (A) - - * Git (Alternate) - Source: http://www.dylanbeattie.net/git_logo/ - Author: Dylan Beattie - License: CC v3 (A, SA) - -.. list-table:: - :widths: 1 10 - :header-rows: 0 - - * - .. image:: /_static/section/download/pypi.png - :target: https://pypi.python.org/pypi/nyx/ - - - .. image:: /_static/label/python_package_index.png - :target: https://pypi.python.org/pypi/nyx/ - - Signed releases and instructions for both Python 2.x and 3.x. You can - easily install from its `tarball - https://www.atagar.com/arm/resources/static/arm-1.4.5.0.tar.bz2`_ - (`sig - https://www.atagar.com/arm/resources/static/arm-1.4.5.0.tar.bz2.asc`_), - or with **pip**... - - :: - - % sudo easy_install pip - % sudo pip install nyx - - * - .. image:: /_static/section/download/osx.png - - - .. image:: /_static/label/osx.png - - As of OSX 10.8 the platform bundles Python 2.7 by default. This makes - installation easy... - - :: - - % sudo easy_install pip - % sudo pip install nyx - - * - .. image:: /_static/section/download/debian.png - :target: http://packages.debian.org/sid/tor-arm - - - .. image:: /_static/label/debian.png - :target: http://packages.debian.org/sid/tor-arm - - Package maintained by Dererk for Debian. - - :: - - % sudo apt-get install tor-arm - - * - .. image:: /_static/section/download/ubuntu.png - :target: https://launchpad.net/ubuntu/+source/tor-arm - - - .. image:: /_static/label/ubuntu.png - :target: https://launchpad.net/ubuntu/+source/tor-arm - - Package derived from Debian for Ubuntu. - - :: - - % sudo apt-get install tor-arm - - * - .. image:: /_static/section/download/fedora.png - :target: https://apps.fedoraproject.org/packages/tor-arm - - - .. image:: /_static/label/fedora.png - :target: https://apps.fedoraproject.org/packages/tor-arm - - Packages maintained by Juan for Fedora. - - :: - - % sudo yum install tor-arm - - * - .. image:: /_static/section/download/gentoo.png - :target: http://packages.gentoo.org/package/net-misc/arm - - - .. image:: /_static/label/gentoo.png - :target: http://packages.gentoo.org/package/net-misc/arm - - Package maintained by Jesse for Gentoo. - - :: - - % sudo emerge arm - - * - .. image:: /_static/section/download/slackware.png - :target: https://slackbuilds.org/repository/13.37/network/arm/ - - - .. image:: /_static/label/slackware.png - :target: https://slackbuilds.org/repository/13.37/network/arm/ - - Package maintained by pyllyukko for `Slackware - http://slackbuilds.org/howto/`_. - - * - .. image:: /_static/section/download/freebsd.png - :target: http://www.freshports.org/security/arm - - - .. image:: /_static/label/freebsd.png - :target: http://www.freshports.org/security/arm - - Port maintained by Carlo for `FreeBSD - http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports.html`_. - - :: - - % pkg install security/arm - - * - .. image:: /_static/section/download/git.png - :target: https://gitweb.torproject.org/nyx.git - - - .. image:: /_static/label/source_repository.png - :target: https://gitweb.torproject.org/nyx.git - - For those wanting to live on the bleeding edge or contribute to Nyx, - Nyx's git repository can be fetched with... - - :: - - % git clone https://git.torproject.org/nyx.git - diff --git a/docs/faq.rst b/docs/faq.rst deleted file mode 100644 index 9bf2dd5..0000000 --- a/docs/faq.rst +++ /dev/null @@ -1,291 +0,0 @@ -Frequently Asked Questions -========================== - -* **General Information** - - * :ref:`what_is_nyx` - * :ref:`why_is_it_called_nyx` - * :ref:`does_nyx_have_any_dependencies` - * :ref:`what_python_versions_is_nyx_compatible_with` - * :ref:`are_there_any_other_tor_uis` - * :ref:`what_license_is_nyx_under` - -* **Usage** - - * :ref:`will_exits_include_user_traffic` - * :ref:`is_it_harmful_to_share_data` - * :ref:`can_nyx_leak_data` - * :ref:`why_dont_i_see_the_bandwith_graph` - * :ref:`why_are_borders_broken` - * :ref:`why_are_relay_details_missing` - -* **Development** - - * :ref:`how_do_i_get_started` - * :ref:`how_do_i_run_the_tests` - * :ref:`how_do_i_build_the_site` - * :ref:`what_is_the_copyright_for_patches` - -General Information -=================== - -.. _what_is_nyx: - -What is Nyx? ------------- - -Nyx is a command-line application for monitoring real time `Tor -https://www.torproject.org/`_ status information. This includes bandwidth -usage, logs, connections, configuration, `and more <screenshots.html>`_. - -.. image:: /_static/section/screenshots/main.png - :target: _static/section/screenshots/main_full.png - -As a curses interface Nyx is particularly well suited for ssh connections, tty -terminals, and command-line aficionados. - -.. _why_is_it_called_nyx: - -Why is it called Nyx? ---------------------- - -Simple - because it's short and memorable. Terminal applications are handiest -when they're easy to remember and type, such as *top*, *ssh*, etc. Anything -longer is just asking to be aliased down. - -Besides, Nyx is the `Greek goddess of night -https://en.wikipedia.org/wiki/Nyx`_. - -.. _does_nyx_have_any_dependencies: - -Does Nyx have any dependencies? -------------------------------- - -**Yes**, Nyx requires `Stem 1.4.5 or later https://stem.torproject.org/`_. - -.. _what_python_versions_is_nyx_compatible_with: - -What Python versions is Nyx compatible with? --------------------------------------------- - -Nyx works with **Python 2.6 and greater**, including the Python 3.x series. - -.. _are_there_any_other_tor_uis: - -Are there any other user interfaces for Tor? --------------------------------------------- - -.. image:: /_static/section/screenshots/vidalia.png - :align: right - -Yes, though sadly this isn't a space that gets much attention. - -For years `Vidalia https://en.wikipedia.org/wiki/Vidalia_%28software%29`_ was -the default interface of Tor until it was replaced in 2013 by `Tor Browser -https://www.torproject.org/projects/torbrowser.html.en`_. Vidalia includes a -launcher, settings editor, map, and more. `TorK -https://sourceforge.net/projects/tork/`_ is similar, providing connection -information as well but never reached the same level of prominence. Both -interfaces are now unmaintained. - -Smaller widgets include... - -* `Syboa https://gitorious.org/syboa/syboa`_ - General interface -* `OnionLauncher https://github.com/neelchauhan/OnionLauncher`_ - Tor launcher -* `TorNova https://github.com/neelchauhan/TorNova`_ - Tor launcher -* `OnionView https://github.com/skyguy/onionview`_ - Circuit information -* `OnionCircuits https://git-tails.immerda.ch/onioncircuits/`_ - Circuit information -* `or-applet https://github.com/Yawning/or-applet`_ - Circuit information - -If I missed any then please `let me know https://www.atagar.com/contact/`_! - -.. _what_license_is_nyx_under: - -What license is Nyx under? --------------------------- - -Nyx is under the `GPLv3 https://www.gnu.org/licenses/gpl`_. - -.. _where_can_i_get_help: - -Usage -===== - -.. _will_exits_include_user_traffic: - -When running an exit will I see people's traffic? -------------------------------------------------- - -**No**. Potential client and exit connections are scrubbed of sensitive -information. Be aware that it's highly discouraged (and possibly illegal) for -relay operators to view this data, so please don't. - -.. _is_it_harmful_to_share_data: - -Is it harmful to share the information provided by Nyx? -------------------------------------------------------- - -**Not really**, but show some moderation. Screenshots of Nyx are unlikely to do -any harm but try to avoid exposing data en mass. - -.. _can_nyx_leak_data: - -Is there any chance that nyx will leak data? --------------------------------------------- - -**No**. Nyx is a completely passive listener, fetching all information from -either Tor or the local system. - -.. _why_dont_i_see_the_bandwith_graph: - -Why don't I see the bandwidth graph? ------------------------------------- - -On some terminals such as Gentoo screen sessions appear to have a bug where -highlighted spaces aren't shown. Try running... - -:: - - export TERM="rxvt-unicode" - -.. _why_are_borders_broken: - -Why are there borders like 'mwqqqqqqqqj'? ------------------------------------------ - - -If you're getting something that looks like... - -.. image:: /_static/section/screenshots/acs_display_failure.png - :target: _static/section/screenshots/acs_display_failure_full.png - -... you are encountering a terminal bug where alternate character support (ACS) -`is unavailable -http://invisible-island.net/ncurses/ncurses.faq.html#no_line_drawing`_. - -Unfortunately there doesn't seem to be a way for Nyx to automatically detect -or correct this. To work around this you can set the following in your nyxrc -to not use ACS borders... - -:: - - features.acsSupport false - -.. _why_are_relay_details_missing: - -Why are relay details for connections missing? ----------------------------------------------- - -Relays publish information about themselves in documents called *descriptors*. -These documents are downloaded by Tor. New documents available on an hourly -basis but Tor will only download them if it needs them, so the descriptors you -have may be older. - -Nyx's connections page use these descriptors to enrich connection information -with data about the relay you're connected with. If Tor doesn't have this -information the data may be stale or missing. - -**This is fine.** Descriptor information we use changes infrequently so even if -they're a few hours old it won't matter. However, if you really need up-to-date -information you can add the following to your torrc... - -:: - - # download new descriptors even if our cache is still valid - - FetchDirInfoEarly 1 - FetchDirInfoExtraEarly 1 - FetchUselessDescriptors 1 - -Development -=========== - -.. _how_do_i_get_started: - -How do I get started? ---------------------- - -The best way of getting involved with any project is to jump right in! Our `bug -tracker https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs`_ lists -several development tasks. In particular look for the 'easy' keyword when -getting started. If you have any questions then I'm always more than happy to -help! I'm **atagar** on `oftc http://www.oftc.net/`_ and also available -`via email https://www.atagar.com/contact/`_. - -To start hacking on Nyx please do the following and don't hesitate to let me -know if you get stuck or would like to discuss anything! - -#. Clone our `git http://git-scm.com/`_ repository: **git clone https://git.torproject.org/nyx.git** -#. Install the development version of `Stem https://stem.torproject.org/`_: **git clone https://git.torproject.org/stem.git; cd stem; sudo python setup.py install**. -#. Get our test dependencies: **sudo pip install mock pep8 pyflakes**. -#. Find a `bug or feature https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs`_ that sounds interesting. -#. When you have something that you would like to contribute back do the following... - - * If you don't already have a publicly accessible Nyx repository then set one up. `GitHub https://github.com/`_ in particular is great for this. - * File a `trac ticket https://trac.torproject.org/projects/tor/newticket`_, the only fields you'll need are... - - * Summary: short description of your change - * Description: longer description and a link to your repository with either the git commits or branch that has your change - * Type: 'defect' if this is a bug fix and 'enhancement' otherwise - * Priority: rough guess at the priority of your change - * Component: Core Tor / Nyx - - * I'll review the change and give suggestions. When we're both happy with it I'll push your change to the official repository. - -.. _how_do_i_run_the_tests: - -How do I run the tests? ------------------------ - -Nyx has unit tests, including tests that exercise our curses functionality. -When you run the tests you may notice your console flicker as these are -exercised. - -If you have them installed we run `pyflakes https://launchpad.net/pyflakes`_ -to do static error checking and `pycodestyle -http://pycodestyle.readthedocs.org/en/latest/`_ for style checking as part of -our tests. - -Tests are run with... - -:: - - % run_tests.py - -.. _how_do_i_build_the_site: - -How do I build the site? ------------------------- - -If you have `Sphinx http://sphinx-doc.org/`_ version 1.1 or later installed -then building our site is as easy as... - -:: - - ~$ cd nyx/docs - ~/nyx/docs$ make html - -When it's finished you can direct your browser to the *_build* directory with a -URI similar to... - -:: - - file:///home/atagar/nyx/docs/_build/html/index.html - -.. _what_is_the_copyright_for_patches: - -What is the copyright for patches? ----------------------------------- - -Nyx is under the GPLv3 which is a fine license, but poses a bit of a problem -for sharing code with our other projects (which are mostly BSD). To share code -without needing to hunt down prior contributors we need Tor to have the -copyright for the whole Nyx codebase. Presently the copyright of Nyx is -jointly held by its main author (`Damian https://www.atagar.com/`_) and the -`Tor Project https://www.torproject.org/`_. - -If you submit a substantial patch I'll ask if you're fine with it being in the -public domain. This would mean that there are no legal restrictions for using -your contribution, and hence won't pose a problem if we reuse Nyx code in -other projects. - diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index d83d79b..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,60 +0,0 @@ -Welcome to Nyx! -=============== - -Nyx is a command line interface for `Tor https://www.torproject.org/`_, providing detailed real-time relaying information. With it you can view bandwidth usage, connections, logs, and much more. Nyx's latest version is **1.4.5** (released April 28th, 2012). - -.. Main Nyx Logo - Source: Oxygen (http://www.oxygen-icons.org/) - Author: Andrea Joseph - License: CCv3 (A, SA) - http://creativecommons.org/licenses/by-sa/3.0/ - File: Oxygen/128x128/apps/utilities-system-monitor.png - -.. Source: Crystal (http://www.everaldo.com/crystal/) - Author: Everaldo Coelho (http://www.everaldo.com/) - License: LGPL v2 - File: Crystal/128x128/filesystems/desktop.png - Crystal/128x128/filesystems/chardevice.png - -.. image:: /_static/buttons/screenshots.png - :target: screenshots.html - -.. Source: https://openclipart.org/detail/171951/help-by-diamonjohn-171951 - Author: John Diamond (https://openclipart.org/user-detail/diamonjohn) - License: Public Domain - - Alternate: - Source: Oxygen (http://www.oxygen-icons.org/) - Author: Andrea Joseph - License: CCv3 (A, SA) - http://creativecommons.org/licenses/by-sa/3.0/ - File: Oxygen/128x128/categories/system-help.png - -.. image:: /_static/buttons/faq.png - :target: faq.html - -.. Source: Nuovo (http://www.silvestre.com.ar/?p=5) - Author: Silvestre Herrera (http://www.silvestre.com.ar/) - License: GPL v2 - File: Nuovo/128x128/mimetypes/gnome-mime-text-log.png - -.. image:: /_static/buttons/change_log.png - :target: change_log.html - -.. Source: Crystal (http://www.everaldo.com/crystal/) - Author: Everaldo Coelho (http://www.everaldo.com/) - License: LGPL v2 - File: Crystal/64x64/apps/bug.png - -.. image:: /_static/buttons/bug_tracker.png - :target: https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs - -.. Source: ColorCons (http://mouserunner.com/Spheres_ColoCons1_Free_Icons.html) - Author: Ken Saunders (http://mouserunner.com/MRDS_Cell.html) - License: CC v2.5 (A, SA) - File: ColorCons/Blue/Download.png - -.. image:: /_static/buttons/download.png - :target: download.html - -.. toctree:: - :maxdepth: 1 - diff --git a/docs/republish b/docs/republish deleted file mode 100755 index c3c683a..0000000 --- a/docs/republish +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/sh - -export PATH=/home/nyx/bin:$PATH -export PYTHONPATH=/home/nyx/lib/python - -python /home/nyx/nyx/docs/republish.py $*& - diff --git a/docs/republish.py b/docs/republish.py deleted file mode 100644 index f9e9d29..0000000 --- a/docs/republish.py +++ /dev/null @@ -1,89 +0,0 @@ -import getopt -import logging -import subprocess -import sys -import time - -LOGGER = logging.getLogger('republish') -LOGGER.setLevel(logging.INFO) - -handler = logging.FileHandler('/home/nyx/republish.log') -handler.setFormatter(logging.Formatter( - fmt = '%(asctime)s [%(levelname)s] %(message)s', - datefmt = '%m/%d/%Y %H:%M:%S', -)) -LOGGER.addHandler(handler) - -OPT = 'r:h' -OPT_EXPANDED = ['repeat=', 'help'] - -HELP_MSG = """\ -Republishes nyx's website. This can either be done or on a reoccurring basis. -If nyx's repository is unchanged then this is a no-op. - - -r, --repeat RATE tries to republish the site at a set rate, in minutes -""" - - -def run(command, cwd = None): - # Runs the given command. This returns the stdout if successful, and raises - # an OSError if it fails. - - cmd = subprocess.Popen(command.split(' '), stdout = subprocess.PIPE, stderr = subprocess.PIPE, cwd = cwd) - - if cmd.wait() == 0: - return cmd.communicate()[0] - else: - stdout, stderr = cmd.communicate() - raise OSError("'%s' failed\n stdout: %s\n stderr: %s" % (command, stdout.strip(), stderr.strip())) - - -def republish_site(): - # Checks if nyx's repository has changed, rebuilding the site if so. Ideally - # we'd use plumbing commands to check this but... meh. Patches welcome. - - if 'Already up-to-date.' not in run('git pull', cwd = '/home/nyx/nyx'): - start_time = time.time() - LOGGER.log(logging.INFO, "Nyx's repository has changed. Republishing...") - run('make html', cwd = '/home/nyx/nyx/docs') - run('sudo -u mirroradm static-master-update-component nyx.torproject.org') - - runtime = int(time.time() - start_time) - LOGGER.log(logging.INFO, ' site republished (took %s seconds)' % runtime) - - -if __name__ == '__main__': - try: - opts = getopt.getopt(sys.argv[1:], OPT, OPT_EXPANDED)[0] - except getopt.GetoptError as exc: - print('%s (for usage provide --help)' % exc) - sys.exit(1) - - repeat_rate = None - - for opt, arg in opts: - if opt in ('-r', '--repeat'): - if arg.isdigit(): - repeat_rate = int(arg) - else: - print("The --repeat argument must be an integer, got '%s'" % arg) - sys.exit(1) - elif opt in ('-h', '--help'): - print(HELP_MSG) - sys.exit() - - if repeat_rate: - LOGGER.log(logging.INFO, 'Starting nyx site republisher') - latest_run = 0 # unix timestamp for when we last ran - - while True: - while time.time() < (latest_run + repeat_rate * 60): - time.sleep(15) - - try: - latest_run = time.time() - republish_site() - except OSError as exc: - LOGGER.log(logging.WARN, str(exc)) - else: - republish_site() diff --git a/docs/roles.py b/docs/roles.py deleted file mode 100644 index 89db29a..0000000 --- a/docs/roles.py +++ /dev/null @@ -1,73 +0,0 @@ -import re - -from docutils.utils import unescape -from docutils.nodes import reference -from docutils.parsers.rst.roles import set_classes - - -def role_trac(name, rawtext, text, lineno, inliner, options={}, content=[]): - """ - Aliases :trac:`1234` to 'https://trac.torproject.org/1234'. - - :param name: the role name used in the document - :param rawtext: the entire markup snippet, with role - :param text: the text marked with the role - :param lineno: the line number where rawtext appears in the input - :param inliner: the inliner instance that called us - :param options: directive options for customization - :param content: the directive content for customization - """ - - # checking if the number is valid - try: - ticket_num = int(text) - - if ticket_num <= 0: - raise ValueError - except ValueError: - msg = inliner.reporter.error('Invalid trac ticket: %s' % text, line=lineno) - prb = inliner.problematic(rawtext, rawtext, msg) - - return ([prb], [msg]) - - app = inliner.document.settings.env.app - link_text = 'ticket %s' % unescape(str(ticket_num)) - - return ( - [make_link_node(rawtext, app, 'trac_url', link_text, str(ticket_num), options)], - [], - ) - - -def make_link_node(rawtext, app, url_type, link_text, slug, options): - """ - Creates a link to a trac ticket. - - :param rawtext: text being replaced with link node - :param app: sphinx application context - :param url_type: base for our url - :param link_text: text for the link - :param slug: ID of the thing to link to - :param options: options dictionary passed to role func - """ - - base_url = getattr(app.config, url_type, None) - - if not base_url: - raise ValueError("'%s' isn't set in our config" % url_type) - - ref = base_url.format(slug = slug) - set_classes(options) - - return reference(rawtext, link_text, refuri = ref, **options) - - -def setup(app): - """ - Installs the plugin. - - :param app: sphinx application context - """ - - app.add_role('trac', role_trac) - app.add_config_value('trac_url', None, 'env') diff --git a/docs/screenshots.rst b/docs/screenshots.rst deleted file mode 100644 index e101871..0000000 --- a/docs/screenshots.rst +++ /dev/null @@ -1,28 +0,0 @@ -Screenshots -=========== - -.. image:: /_static/section/screenshots/main.png - :target: _static/section/screenshots/main_full.png - -**Bandwidth graph and event log** - -.. image:: /_static/section/screenshots/connections.png - :target: _static/section/screenshots/connections_full.png - -**Relay connection listing** - -.. image:: /_static/section/screenshots/config.png - :target: _static/section/screenshots/config_full.png - -**Configuration Editor** - -.. image:: /_static/section/screenshots/torrc.png - :target: _static/section/screenshots/torrc_full.png - -**Torrc** - -.. image:: /_static/section/screenshots/interpreter.png - :target: _static/section/screenshots/interpreter_full.png - -**Interactive Interpreter** -