From 236f84d6d4ac299b18b9763c3fbcbc36626114ca Mon Sep 17 00:00:00 2001 From: hpk Date: Mon, 13 Apr 2009 15:58:26 +0200 Subject: [PATCH] [svn r64029] * move test docs into their own subdir * don't use sphinx for now, put the support code to attic * remove some old docs --HG-- branch : trunk --- doc/Makefile | 94 -- doc/__init__.py | 1 - doc/_templates/pylib/static/style.css_t | 1080 ----------------- doc/_templates/pylib/theme.conf | 9 - doc/{ => announce}/releases.txt | 0 doc/bin.txt | 2 +- doc/coding-style.txt | 65 - doc/conf.py | 195 --- doc/confrest.py | 5 + doc/conftest.py | 2 + doc/contact.txt | 1 - doc/index.txt | 2 +- doc/make.bat | 112 -- doc/roles.py | 5 - doc/{impl-test.txt => test/attic.txt} | 2 +- doc/{test-config.txt => test/config.txt} | 0 doc/{test-dist.txt => test/dist.txt} | 4 +- doc/{test-examples.txt => test/examples.txt} | 0 doc/{test-ext.txt => test/ext.txt} | 9 +- doc/{test-features.txt => test/features.txt} | 36 +- doc/{test-funcargs.txt => test/funcargs.txt} | 0 doc/{test-plugins.txt => test/plugins.txt} | 0 .../quickstart.txt} | 4 +- .../statemanage.txt} | 0 doc/{ => test}/test.txt | 26 +- doc/xml.txt | 2 +- 26 files changed, 47 insertions(+), 1609 deletions(-) delete mode 100644 doc/Makefile delete mode 100644 doc/__init__.py delete mode 100644 doc/_templates/pylib/static/style.css_t delete mode 100644 doc/_templates/pylib/theme.conf rename doc/{ => announce}/releases.txt (100%) delete mode 100644 doc/coding-style.txt delete mode 100644 doc/conf.py delete mode 100644 doc/make.bat delete mode 100644 doc/roles.py rename doc/{impl-test.txt => test/attic.txt} (97%) rename doc/{test-config.txt => test/config.txt} (100%) rename doc/{test-dist.txt => test/dist.txt} (98%) rename doc/{test-examples.txt => test/examples.txt} (100%) rename doc/{test-ext.txt => test/ext.txt} (96%) rename doc/{test-features.txt => test/features.txt} (92%) rename doc/{test-funcargs.txt => test/funcargs.txt} (100%) rename doc/{test-plugins.txt => test/plugins.txt} (100%) rename doc/{test-quickstart.txt => test/quickstart.txt} (96%) rename doc/{test-statemanage.txt => test/statemanage.txt} (100%) rename doc/{ => test}/test.txt (52%) diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index 2540aeef5..000000000 --- a/doc/Makefile +++ /dev/null @@ -1,94 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " htmlall to force make all standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @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 " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @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 _build/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html - @echo - @echo "Build finished. The HTML pages are in _build/html." - -htmlall: - $(SPHINXBUILD) -a -b html $(ALLSPHINXOPTS) _build/html - @echo - @echo "Build finished. The HTML pages are in _build/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml - @echo - @echo "Build finished. The HTML pages are in _build/dirhtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in _build/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in _build/qthelp, like this:" - @echo "# qcollectiongenerator _build/qthelp/py lib.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile _build/qthelp/py lib.qhc" - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex - @echo - @echo "Build finished; the LaTeX files are in _build/latex." - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ - "run these through (pdf)latex." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes - @echo - @echo "The overview file is in _build/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in _build/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in _build/doctest/output.txt." diff --git a/doc/__init__.py b/doc/__init__.py deleted file mode 100644 index 792d60054..000000000 --- a/doc/__init__.py +++ /dev/null @@ -1 +0,0 @@ -# diff --git a/doc/_templates/pylib/static/style.css_t b/doc/_templates/pylib/static/style.css_t deleted file mode 100644 index 6ed0ae9e8..000000000 --- a/doc/_templates/pylib/static/style.css_t +++ /dev/null @@ -1,1080 +0,0 @@ -@import url("basic.css"); - -body,body.editor,body.body { - font: 110% Verdana, Helvetica, Arial, serif; - background: White; - color: Black; -} - -a, a.reference { - text-decoration: none; -} -a[href]:hover { text-decoration: underline; } - -img { - border: none; - vertical-align: middle; -} - -p, div.text { - text-align: left; - line-height: 1.5em; - margin: 0.5em 0em 0em 0em; -} - - - -p a:active { - color: Red; - background-color: transparent; -} - -p img { - border: 0; - margin: 0; -} - -img.inlinephoto { - padding: 0; - padding-right: 1em; - padding-top: 0.7em; - float: left; -} - -hr { - clear: both; - height: 1px; - color: #8CACBB; - background-color: transparent; -} - - -ul { - line-height: 1.5em; - /*list-style-image: url("bullet.gif"); */ - margin-left: 1.5em; - padding:0; -} - -ol { - line-height: 1.5em; - margin-left: 1.5em; - padding:0; -} - -ul a, ol a { - text-decoration: underline; -} - -dl { -} - -dt { - font-weight: bold; -} - -dd { - line-height: 1.5em; - margin-bottom: 1em; -} - -blockquote { - font-family: Times, "Times New Roman", serif; - font-style: italic; - font-size: 120%; -} - -code { - color: Black; - /*background-color: #dee7ec;*/ - background-color: #cccccc; -} - -pre { - padding: 1em; - border: 1px solid #8cacbb; - color: Black; - background-color: #dee7ec; - background-color: #cccccc; - overflow: auto; -} - - -.netscape4 { - display: none; -} - -/* main page styles */ - -/*a[href]:hover { color: black; text-decoration: underline; } -a[href]:link { color: black; text-decoration: underline; } -a[href] { color: black; text-decoration: underline; } -*/ - -span.menu_selected { - color: black; - font: 140% Verdana, Helvetica, Arial, sans-serif; - text-decoration: none; - padding-right: 0.3em; - background-color: #cccccc; -} - - -a.menu { - /*color: #3ba6ec; */ - font: 140% Verdana, Helvetica, Arial, sans-serif; - text-decoration: none; - padding-right: 0.3em; -} - -a.menu[href]:visited, a.menu[href]:link{ - /*color: #3ba6ec; */ - font: 140% Verdana, Helvetica, Arial, sans-serif; - text-decoration: none; -} - -a.menu[href]:hover { - /*color: black;*/ -} - -div.project_title{ - /*border-spacing: 20px;*/ - font: 160% Verdana, Helvetica, Arial, sans-serif; - color: #3ba6ec; - vertical-align: middle; - padding-bottom: 0.3em; -} - -a.wikicurrent { - font: 100% Verdana, Helvetica, Arial, sans-serif; - color: #3ba6ec; - vertical-align: middle; -} - - -table.body { - border: 0; - /*padding: 0; - border-spacing: 0px; - border-collapse: separate; - */ -} - -td.page-header-left { - padding: 5px; - /*border-bottom: 1px solid #444444;*/ -} - -td.page-header-top { - padding: 0; - - /*border-bottom: 1px solid #444444;*/ -} - -td.sidebar { - padding: 1 0 0 1; -} - -td.sidebar p.classblock { - padding: 0 5 0 5; - margin: 1 1 1 1; - border: 1px solid #444444; - background-color: #eeeeee; -} - -td.sidebar p.userblock { - padding: 0 5 0 5; - margin: 1 1 1 1; - border: 1px solid #444444; - background-color: #eeeeff; -} - -td.content { - padding: 1 5 1 5; - vertical-align: top; - width: 100%; -} - -p.ok-message { - background-color: #22bb22; - padding: 5 5 5 5; - color: white; - font-weight: bold; -} -p.error-message { - background-color: #bb2222; - padding: 5 5 5 5; - color: white; - font-weight: bold; -} - -p:first-child { - margin: 0 ; - padding: 0; -} - -/* style for forms */ -table.form { - padding: 2; - border-spacing: 0px; - border-collapse: separate; -} - -table.form th { - color: #333388; - text-align: right; - vertical-align: top; - font-weight: normal; -} -table.form th.header { - font-weight: bold; - background-color: #eeeeff; - text-align: left; -} - -table.form th.required { - font-weight: bold; -} - -table.form td { - color: #333333; - empty-cells: show; - vertical-align: top; -} - -table.form td.optional { - font-weight: bold; - font-style: italic; -} - -table.form td.html { - color: #777777; -} - -/* style for lists */ -table.list { - border-spacing: 0px; - border-collapse: separate; - vertical-align: top; - padding-top: 0; - width: 100%; -} - -table.list th { - padding: 0 4 0 4; - color: #404070; - background-color: #eeeeff; - border-right: 1px solid #404070; - border-top: 1px solid #404070; - border-bottom: 1px solid #404070; - vertical-align: top; - empty-cells: show; -} -table.list th a[href]:hover { color: #404070 } -table.list th a[href]:link { color: #404070 } -table.list th a[href] { color: #404070 } -table.list th.group { - background-color: #f4f4ff; - text-align: center; - font-size: 120%; -} - -table.list td { - padding: 0 4 0 4; - border: 0 2 0 2; - border-right: 1px solid #404070; - color: #404070; - background-color: white; - vertical-align: top; - empty-cells: show; -} - -table.list tr.normal td { - background-color: white; - white-space: nowrap; -} - -table.list tr.alt td { - background-color: #efefef; - white-space: nowrap; -} - -table.list td:first-child { - border-left: 1px solid #404070; - border-right: 1px solid #404070; -} - -table.list th:first-child { - border-left: 1px solid #404070; - border-right: 1px solid #404070; -} - -table.list tr.navigation th { - text-align: right; -} -table.list tr.navigation th:first-child { - border-right: none; - text-align: left; -} - - -/* style for message displays */ -table.messages { - border-spacing: 0px; - border-collapse: separate; - width: 100%; -} - -table.messages th.header{ - padding-top: 10px; - border-bottom: 1px solid gray; - font-weight: bold; - background-color: white; - color: #707040; -} - -table.messages th { - font-weight: bold; - color: black; - text-align: left; - border-bottom: 1px solid #afafaf; -} - -table.messages td { - font-family: monospace; - background-color: #efefef; - border-bottom: 1px solid #afafaf; - color: black; - empty-cells: show; - border-right: 1px solid #afafaf; - vertical-align: top; - padding: 2 5 2 5; -} - -table.messages td:first-child { - border-left: 1px solid #afafaf; - border-right: 1px solid #afafaf; -} - -/* style for file displays */ -table.files { - border-spacing: 0px; - border-collapse: separate; - width: 100%; -} - -table.files th.header{ - padding-top: 10px; - border-bottom: 1px solid gray; - font-weight: bold; - background-color: white; - color: #707040; -} - -table.files th { - border-bottom: 1px solid #afafaf; - font-weight: bold; - text-align: left; -} - -table.files td { - font-family: monospace; - empty-cells: show; -} - -/* style for history displays */ -table.history { - border-spacing: 0px; - border-collapse: separate; - width: 100%; -} - -table.history th.header{ - padding-top: 10px; - border-bottom: 1px solid gray; - font-weight: bold; - background-color: white; - color: #707040; - font-size: 100%; -} - -table.history th { - border-bottom: 1px solid #afafaf; - font-weight: bold; - text-align: left; - font-size: 90%; -} - -table.history td { - font-size: 90%; - vertical-align: top; - empty-cells: show; -} - - -/* style for class list */ -table.classlist { - border-spacing: 0px; - border-collapse: separate; - width: 100%; -} - -table.classlist th.header{ - padding-top: 10px; - border-bottom: 1px solid gray; - font-weight: bold; - background-color: white; - color: #707040; -} - -table.classlist th { - font-weight: bold; - text-align: left; -} - - -/* style for class help display */ -table.classhelp { - border-spacing: 0px; - border-collapse: separate; - width: 100%; -} - -table.classhelp th { - font-weight: bold; - text-align: left; - color: #707040; -} - -table.classhelp td { - padding: 2 2 2 2; - border: 1px solid black; - text-align: left; - vertical-align: top; - empty-cells: show; -} - - -/* style for "other" displays */ -table.otherinfo { - border-spacing: 0px; - border-collapse: separate; - width: 100%; -} - -table.otherinfo th.header{ - padding-top: 10px; - border-bottom: 1px solid gray; - font-weight: bold; - background-color: white; - color: #707040; -} - -table.otherinfo th { - border-bottom: 1px solid #afafaf; - font-weight: bold; - text-align: left; -} - -input { - border: 1px solid #8cacbb; - color: Black; - background-color: white; - vertical-align: middle; - margin-bottom: 1px; /* IE bug fix */ - padding: 0.1em; -} - -select { - border: 1px solid #8cacbb; - color: Black; - background-color: white; - vertical-align: middle; - margin-bottom: 1px; /* IE bug fix */ - padding: 0.1em; -} - - -a.nonexistent { - color: #FF2222; -} -a.nonexistent:visited { - color: #FF2222; -} -a.external { - color: #AA6600; -} - -/* -dl,ul,ol { - margin-top: 1pt; -} -tt,pre { - font-family: Lucida Console,Courier New,Courier,monotype; - font-size: 12pt; -} -pre.code { - margin-top: 8pt; - margin-bottom: 8pt; - background-color: #FFFFEE; - white-space:pre; - border-style:solid; - border-width:1pt; - border-color:#999999; - color:#111111; - padding:5px; - width:100%; -} -*/ -div.diffold { - background-color: #FFFF80; - border-style:none; - border-width:thin; - width:100%; -} -div.diffnew { - background-color: #80FF80; - border-style:none; - border-width:thin; - width:100%; -} -div.message { - margin-top: 6pt; - background-color: #E8FFE8; - border-style:solid; - border-width:1pt; - border-color:#999999; - color:#440000; - padding:5px; - width:100%; -} -strong.highlight { - background-color: #FFBBBB; -/* as usual, NetScape fucks up with innocent CSS - border-color: #FFAAAA; - border-style: solid; - border-width: 1pt; -*/ -} - -table.navibar { - background-color: #C8C8C8; - border-spacing: 3px; -} -td.navibar { - background-color: #E8E8E8; - vertical-align: top; - text-align: right; - padding: 0px; -} - -div.pagename { - font-size: 140%; - color: blue; - text-align: center; - font-weight: bold; - background-color: white; - padding: 0 ; -} - -a.wikiaction, input.wikiaction { - color: black; - text-decoration: None; - text-align: center; - color: black; - /*border: 1px solid #3ba6ec; */ - margin: 4px; - padding: 5; - padding-bottom: 0; - white-space: nowrap; -} - -a.wikiaction[href]:hover { - color: black; - text-decoration: none; - /*background-color: #dddddd; */ -} - -span.wikiuserpref { - padding-top: 1em; - font-size: 120%; -} - -div.wikitrail { - vertical-align: bottom; - /*font-size: -1;*/ - padding-top: 1em; - display: none; -} - -div.wikiaction { - vertical-align: middle; - /*border-bottom: 1px solid #8cacbb;*/ - padding-bottom:1em; - text-align: left; - width: 100%; -} - -div.wikieditmenu { - text-align: right; -} - -form.wikiedit { - border: 1px solid #8cacbb; - background-color: #f0f0f0; - background-color: #fabf00; - padding: 1em; - padding-right: 0em; -} - -div.legenditem { - padding-top: 0.5em; - padding-left: 0.3em; -} - -span.wikitoken { - background-color: #eeeeee; -} - - -div#contentspace h1:first-child, div.heading:first-child { - padding-top: 0; - margin-top: 0; -} -div#contentspace h2:first-child { - padding-top: 0; - margin-top: 0; -} - -/* heading and paragraph text */ - -div.heading, h1 { - font-family: Verdana, Helvetica, Arial, sans-serif; - background-color: #58b3ef; - background-color: #FFFFFF; - /*color: #4893cf;*/ - color: black; - padding-top: 1.0em; - padding-bottom:0.2em; - text-align: left; - margin-top: 0em; - /*margin-bottom:8pt;*/ - font-weight: bold; - font-size: 115%; - border-bottom: 1px solid #8CACBB; -} - - -h1, h2, h3, h4, h5, h6 { - color: Black; - clear: left; - font: 100% Verdana, Helvetica, Arial, sans-serif; - margin: 0; - padding-left: 0em; - padding-top: 1em; - padding-bottom: 0.2em; - /*border-bottom: 1px solid #8CACBB;*/ -} -/* h1,h2 { padding-top: 0; }*/ - - -h1 { font-size: 145%; } -h2 { font-size: 135%; } -h3 { font-size: 125%; } -h4 { font-size: 120%; } -h5 { font-size: 110%; } -h6 { font-size: 80%; } - -h1 a { text-decoration: None;} - -div.exception { - background-color: #bb2222; - padding: 5 5 5 5; - color: white; - font-weight: bold; -} -pre.exception { - font-size: 110%; - padding: 1em; - border: 1px solid #8cacbb; - color: Black; - background-color: #dee7ec; - background-color: #cccccc; -} - -/* defines for navgiation bar (documentation) */ - - -div.direntry { - padding-top: 0.3em; - padding-bottom: 0.3em; - margin-right: 1em; - font-weight: bold; - background-color: #dee7ec; - font-size: 110%; -} - -div.fileentry { - font-family: Verdana, Helvetica, Arial, sans-serif; - padding-bottom: 0.3em; - white-space: nowrap; - line-height: 150%; -} - -a.fileentry { - white-space: nowrap; -} - - -span.left { - text-align: left; -} -span.right { - text-align: right; -} - -div.navbar { - /*margin: 0;*/ - font-size: 80% /*smaller*/; - font-weight: bold; - text-align: left; - /* position: fixed; */ - top: 100pt; - left: 0pt; /* auto; */ - width: 120pt; - /* right: auto; - right: 0pt; 2em; */ -} - - -div.history a { - /* font-size: 70%; */ -} - -div.wikiactiontitle { - font-weight: bold; -} - -/* REST defines */ - -div.document { - margin: 0; -} - -h1.title { - margin: 0; - margin-bottom: 0.5em; -} - -td.toplist { - vertical-align: top; -} - -img#pyimg { - position: absolute; - top: 4px; - left: 4px; -} - -div#navspace { - position: absolute; - top: 100px; - left: 11px; - font-size: 100%; - width: 150px; - overflow: hidden; /* scroll; */ -} - -div#metaspace { - position: absolute; - top: 10px; - left: 170px; -} - -div#errorline { - position: relative; - top: 5px; - float: right; -} - -div#contentspace { - position: absolute; - /* font: 120% "Times New Roman", serif;*/ - font: 110% Verdana, Helvetica, Arial, sans-serif; - top: 100px; - left: 170px; - margin-right: 5px; -} - -div#menubar { -/* width: 400px; */ - float: left; -} - -/* for the documentation page */ -div#docinfoline { - position: relative; - top: 5px; - left: 0px; - - /*background-color: #dee7ec; */ - padding: 5pt; - padding-bottom: 1em; - color: black; - /*border-width: 1pt; - border-style: solid;*/ - -} - -div#docnavlist { - /*background-color: #dee7ec; */ - padding: 5pt; - padding-bottom: 2em; - color: black; - border-width: 1pt; - /*border-style: solid;*/ -} - - -/* text markup */ - -div.listtitle { - color: Black; - clear: left; - font: 120% Verdana, Helvetica, Arial, sans-serif; - margin: 0; - padding-left: 0em; - padding-top: 0em; - padding-bottom: 0.2em; - margin-right: 0.5em; - border-bottom: 1px solid #8CACBB; -} - -div.actionbox h3 { - padding-top: 0; - padding-right: 0.5em; - padding-left: 0.5em; - background-color: #fabf00; - text-align: center; - border: 1px solid black; /* 8cacbb; */ -} - -div.actionbox a { - display: block; - padding-bottom: 0.5em; - padding-top: 0.5em; - margin-left: 0.5em; -} - -div.actionbox a.history { - display: block; - padding-bottom: 0.5em; - padding-top: 0.5em; - margin-left: 0.5em; - font-size: 90%; -} - -div.actionbox { - margin-bottom: 2em; - padding-bottom: 1em; - overflow: hidden; /* scroll; */ -} - -/* taken from docutils (oh dear, a bit senseless) */ -ol.simple, ul.simple { - margin-bottom: 1em } - -ol.arabic { - list-style: decimal } - -ol.loweralpha { - list-style: lower-alpha } - -ol.upperalpha { - list-style: upper-alpha } - -ol.lowerroman { - list-style: lower-roman } - -ol.upperroman { - list-style: upper-roman } - - -/* -:Author: David Goodger -:Contact: goodger@users.sourceforge.net -:date: $Date: 2003/01/22 22:26:48 $ -:version: $Revision: 1.29 $ -:copyright: This stylesheet has been placed in the public domain. - -Default cascading style sheet for the HTML output of Docutils. -*/ -/* -.first { - margin-top: 0 } - -.last { - margin-bottom: 0 } - -a.toc-backref { - text-decoration: none ; - color: black } - -dd { - margin-bottom: 0.5em } - -div.abstract { - margin: 2em 5em } - -div.abstract p.topic-title { - font-weight: bold ; - text-align: center } - -div.attention, div.caution, div.danger, div.error, div.hint, -div.important, div.note, div.tip, div.warning { - margin: 2em ; - border: medium outset ; - padding: 1em } - -div.attention p.admonition-title, div.caution p.admonition-title, -div.danger p.admonition-title, div.error p.admonition-title, -div.warning p.admonition-title { - color: red ; - font-weight: bold ; - font-family: sans-serif } - -div.hint p.admonition-title, div.important p.admonition-title, -div.note p.admonition-title, div.tip p.admonition-title { - font-weight: bold ; - font-family: sans-serif } - -div.dedication { - margin: 2em 5em ; - text-align: center ; - font-style: italic } - -div.dedication p.topic-title { - font-weight: bold ; - font-style: normal } - -div.figure { - margin-left: 2em } - -div.footer, div.header { - font-size: smaller } - -div.system-messages { - margin: 5em } - -div.system-messages h1 { - color: red } - -div.system-message { - border: medium outset ; - padding: 1em } - -div.system-message p.system-message-title { - color: red ; - font-weight: bold } - -div.topic { - margin: 2em } - -h1.title { - text-align: center } - -h2.subtitle { - text-align: center } - -hr { - width: 75% } - -p.caption { - font-style: italic } - -p.credits { - font-style: italic ; - font-size: smaller } - -p.label { - white-space: nowrap } - -p.topic-title { - font-weight: bold } - -pre.address { - margin-bottom: 0 ; - margin-top: 0 ; - font-family: serif ; - font-size: 100% } - -pre.line-block { - font-family: serif ; - font-size: 100% } - -pre.literal-block, pre.doctest-block { - margin-left: 2em ; - margin-right: 2em ; - background-color: #eeeeee } - -span.classifier { - font-family: sans-serif ; - font-style: oblique } - -span.classifier-delimiter { - font-family: sans-serif ; - font-weight: bold } - -span.interpreted { - font-family: sans-serif } - -span.option { - white-space: nowrap } - -span.option-argument { - font-style: italic } - -span.pre { - white-space: pre } - -span.problematic { - color: red } - -table { - margin-top: 0.5em ; - margin-bottom: 0.5em } - -table.citation { - border-left: solid thin gray ; - padding-left: 0.5ex } - -table.docinfo { - margin: 2em 4em } - -table.footnote { - border-left: solid thin black ; - padding-left: 0.5ex } - -td, th { - padding-left: 0.5em ; - padding-right: 0.5em ; - vertical-align: top } - -th.docinfo-name, th.field-name { - font-weight: bold ; - text-align: left ; - white-space: nowrap } - -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { - font-size: 100% } - -tt { - background-color: #eeeeee } - -ul.auto-toc { - list-style-type: none } -*/ - -div.section { - margin-top: 1.0em ; -} diff --git a/doc/_templates/pylib/theme.conf b/doc/_templates/pylib/theme.conf deleted file mode 100644 index d38308fd5..000000000 --- a/doc/_templates/pylib/theme.conf +++ /dev/null @@ -1,9 +0,0 @@ -[theme] -inherit = default -stylesheet = style.css -pygments_style = sphinx - -[options] -rightsidebar = false -stickysidebar = false - diff --git a/doc/releases.txt b/doc/announce/releases.txt similarity index 100% rename from doc/releases.txt rename to doc/announce/releases.txt diff --git a/doc/bin.txt b/doc/bin.txt index 9c68845be..e62766ef9 100644 --- a/doc/bin.txt +++ b/doc/bin.txt @@ -15,7 +15,7 @@ available on your command prompt. The ``py.test`` executable is the main entry point into the py-lib testing tool, see the `py.test documentation`_. -.. _`py.test documentation`: test.html +.. _`py.test documentation`: test/test.html ``py.cleanup`` ============== diff --git a/doc/coding-style.txt b/doc/coding-style.txt deleted file mode 100644 index 340dc8d28..000000000 --- a/doc/coding-style.txt +++ /dev/null @@ -1,65 +0,0 @@ -===================================================== -Coding Style for the Py lib and friendly applications -===================================================== - - -Honour PEP 8: Style Guide for Python Code ------------------------------------------ - -First of all, if you haven't already read it, read the `PEP 8 -Style Guide for Python Code`_ which, if in doubt, serves as -the default coding-style for the py lib. - -Documentation and Testing -------------------------- - -- generally we want to drive and interweave coding of - documentation, tests and real code as much as possible. - Without good documentation others may never know about - your latest and greatest feature. - -naming ------- - -- directories, modules and namespaces are always **lowercase** - -- classes and especially Exceptions are most often **CamelCase** - -- types, i.e. very widely usable classes like the ``py.path`` - family are all lower case. - -- never use plural names in directory and file names - -- functions/methods are lowercase and ``_`` - separated if - you really need to separate at all - -- it's appreciated if you manage to name files in a directory - so that tab-completion on the shell level is as easy as possible. - - -committing ----------- - -- adding features requires adding appropriate tests. - -- bug fixes should be encoded in a test before being fixed. - -- write telling log messages because several people - will read your diffs, and we plan to have a search facility - over the py lib's subversion repository. - -- if you add ``.txt`` or ``.py`` files to the repository then - please make sure you have ``svn:eol-style`` set to native. - which allows checkin/checkout in native line-ending format. - -Miscellaneous -------------- - -- Tests are the insurance that your code will be maintained - further and survives major releases. - -- Try to put the tests close to the tested code, don't - overload directories with names. - -.. _`PEP 8 Style Guide for Python Code`: http://www.python.org/peps/pep-0008.html -.. _`py-dev mailing list`: http://codespeak.net/mailman/listinfo/py-dev diff --git a/doc/conf.py b/doc/conf.py deleted file mode 100644 index 185474f9d..000000000 --- a/doc/conf.py +++ /dev/null @@ -1,195 +0,0 @@ -# -*- coding: utf-8 -*- -# -# py lib documentation build configuration file, created by -# sphinx-quickstart on Wed Apr 1 19:13:13 2009. -# -# 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.append(os.path.abspath('.')) -sys.path.append(os.path.abspath('.')) - -# -- General configuration ----------------------------------------------------- - -# 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.doctest', 'roles'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.txt' - -# The encoding of source files. -#source_encoding = 'utf-8' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'py lib' -copyright = u'2009, Holger Krekel and others' - -# 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 = '1.0' -# The full version, including alpha/beta/rc tags. -release = '1.0.0b1' - -# 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 documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = ['_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. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = 'pylib' - -# 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 = ['_templates'] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = "img/pylib.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 = None - -# 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 = True - -# 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_use_modindex = 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, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'pylibdoc' - - -# -- 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', 'pylib.tex', u'py lib Documentation', - u'Holger Krekel', '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 - -# 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_use_modindex = True diff --git a/doc/confrest.py b/doc/confrest.py index a03812ef1..eee5748b1 100644 --- a/doc/confrest.py +++ b/doc/confrest.py @@ -22,6 +22,9 @@ class Page(object): self._root = html.html(self.head, self.body) self.fill() + def a_href(self, name, url): + return html.a(name, class_="menu", href=url) + def a_docref(self, name, relhtmlpath): docpath = self.project.docpath return html.a(name, class_="menu", @@ -39,6 +42,8 @@ class Page(object): self.a_docref("index", "index.html"), #self.a_apigenref("api", "api/index.html"), #self.a_apigenref("source", "source/index.html"), + #self.a_href("source", "http://bitbucket.org/hpk42/py-trunk/src/"), + self.a_href("issues", "http://bitbucket.org/hpk42/py-trunk/issues/"), self.a_docref("contact", "contact.html"), self.a_docref("download", "download.html"), ] diff --git a/doc/conftest.py b/doc/conftest.py index 51e028516..20d6b9b1b 100644 --- a/doc/conftest.py +++ b/doc/conftest.py @@ -1,3 +1,5 @@ #XXX make work: excludedirs = ['_build'] +import py +py.test.importorskip("pygments") pytest_plugins = ['pytest_restdoc'] rsyncdirs = ['.'] diff --git a/doc/contact.txt b/doc/contact.txt index 7e3857da5..f457fa42b 100644 --- a/doc/contact.txt +++ b/doc/contact.txt @@ -32,7 +32,6 @@ Contact and communication or the mailing list and ask questions, get involved. .. _FOAF: http://en.wikipedia.org/wiki/FOAF -.. _`coding style`: coding-style.html .. _us: http://codespeak.net/mailman/listinfo/py-dev .. _codespeak: http://codespeak.net/ .. _`py-dev`: diff --git a/doc/index.txt b/doc/index.txt index ece6ac16b..1f566bfe2 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -30,7 +30,7 @@ Minor support functionality .. _`py.io`: io.html .. _`py.path`: path.html .. _`py.code`: code.html -.. _`py.test`: test.html +.. _`py.test`: test/test.html .. _`py lib scripts`: bin.html .. _`py.xml`: xml.html .. _`miscellaneous features`: misc.html diff --git a/doc/make.bat b/doc/make.bat deleted file mode 100644 index 4321541a4..000000000 --- a/doc/make.bat +++ /dev/null @@ -1,112 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -set SPHINXBUILD=sphinx-build -set ALLSPHINXOPTS=-d _build/doctrees %SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - 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. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. changes to make an overview over 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 - goto end -) - -if "%1" == "clean" ( - for /d %%i in (_build\*) do rmdir /q /s %%i - del /q /s _build\* - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html - echo. - echo.Build finished. The HTML pages are in _build/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% _build/dirhtml - echo. - echo.Build finished. The HTML pages are in _build/dirhtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in _build/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in _build/qthelp, like this: - echo.^> qcollectiongenerator _build\qthelp\py lib.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile _build\qthelp\py lib.ghc - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% _build/latex - echo. - echo.Build finished; the LaTeX files are in _build/latex. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes - echo. - echo.The overview file is in _build/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck - echo. - echo.Link check complete; look for any errors in the above output ^ -or in _build/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in _build/doctest/output.txt. - goto end -) - -:end diff --git a/doc/roles.py b/doc/roles.py deleted file mode 100644 index a40abef3e..000000000 --- a/doc/roles.py +++ /dev/null @@ -1,5 +0,0 @@ -from docutils.nodes import literal - -def setup(app): - app.add_generic_role('api', literal) - app.add_generic_role('source', literal) diff --git a/doc/impl-test.txt b/doc/test/attic.txt similarity index 97% rename from doc/impl-test.txt rename to doc/test/attic.txt index 805123a97..2e8c98607 100644 --- a/doc/impl-test.txt +++ b/doc/test/attic.txt @@ -46,7 +46,7 @@ useful for calling application test machinery with different parameter sets but counting each of the calls as a separate tests. -.. _`generative tests`: test-features.html#generative-tests +.. _`generative tests`: features.html#generative-tests The other extension possibility is about specifying a custom test ``Item`` class which diff --git a/doc/test-config.txt b/doc/test/config.txt similarity index 100% rename from doc/test-config.txt rename to doc/test/config.txt diff --git a/doc/test-dist.txt b/doc/test/dist.txt similarity index 98% rename from doc/test-dist.txt rename to doc/test/dist.txt index 2c4201be5..45fcf05f3 100644 --- a/doc/test-dist.txt +++ b/doc/test/dist.txt @@ -93,10 +93,10 @@ platforms - and report back failures from all platforms at once. The provided specifications strings use the `xspec syntax`_. -.. _`xspec syntax`: execnet.html#xspec +.. _`xspec syntax`: ../execnet.html#xspec .. _`socketserver.py`: http://codespeak.net/svn/py/dist/py/execnet/script/socketserver.py -.. _`py.execnet`: execnet.html +.. _`py.execnet`: ../execnet.html Specifying test exec environments in a conftest.py ------------------------------------------------------------- diff --git a/doc/test-examples.txt b/doc/test/examples.txt similarity index 100% rename from doc/test-examples.txt rename to doc/test/examples.txt diff --git a/doc/test-ext.txt b/doc/test/ext.txt similarity index 96% rename from doc/test-ext.txt rename to doc/test/ext.txt index 323540db5..edf1d7438 100644 --- a/doc/test-ext.txt +++ b/doc/test/ext.txt @@ -110,11 +110,4 @@ name. Given a filesystem ``fspath`` it is constructed as follows: Plugin hooks and events ======================================= -.. automodule:: py.__.test.plugin.api - -.. autoclass:: PluginHooks - :members: - -.. autoclass:: Events - :members: - +XXX diff --git a/doc/test-features.txt b/doc/test/features.txt similarity index 92% rename from doc/test-features.txt rename to doc/test/features.txt index 81d376ecb..68e0b2a71 100644 --- a/doc/test-features.txt +++ b/doc/test/features.txt @@ -1,18 +1,26 @@ ================================================== -Features +py.test Features ================================================== -py.test is a standalone-tool that collects and runs tests for -your Python application and modules. py.test works across -linux, windows and osx and on Python 2.3 - Python 2.6. +py.test is an extensible tool for running all kinds +of tests one one or more machines. It supports a variety +of testing methods for your Python application and modules, +including unit, functional, integration and doc-testing. -It aims to support *unit-tests* and *functional tests* written -in Python and is used in projects that run more than 10000 -tests regularly. +It is used in projects that run more than 10000 tests +daily as well as single-python-module projects. py.test presents a clean and powerful command line interface and strives to generally make testing a fun effort. +py.test 1.0 works across linux, windows and osx +and on Python 2.3 - Python 2.6. + +More detailed feature list: + +.. contents:: + :depth: 1 + automatically collects and executes tests =============================================== @@ -23,7 +31,13 @@ From each test module every function with a leading ``test_`` or class with a leading ``Test`` name is collected. .. _`generative tests`: -.. _`collection process`: test-ext.html#collection-process +.. _`collection process`: ext.html#collection-process + +Rapidly write integration, functional, unit tests +=================================================== + +py.test provides + load-balance tests to multiple CPUs =================================== @@ -35,7 +49,7 @@ tests to multiple CPUs by issuing for example:: Read more on `distributed testing`_. -.. _`distributed testing`: test-dist.html +.. _`distributed testing`: dist.html Distribute tests across machines =================================== @@ -47,7 +61,7 @@ platforms one a single test run`. Ad-hoc means that there are **no installation requirements whatsoever** on the remote side. -.. _`ad-hoc run your test on multiple platforms one a single test run`: test-dist.html#atonce +.. _`ad-hoc run your test on multiple platforms one a single test run`: dist.html#atonce extensive debugging support =================================== @@ -270,7 +284,7 @@ for these purposes: * running non-python tests * managing test state setup -.. _`py.test plugins`: test-plugins.html +.. _`py.test plugins`: plugins.html .. _`reStructured Text`: http://docutils.sourceforge.net .. _`Python debugger`: http://docs.python.org/lib/module-pdb.html diff --git a/doc/test-funcargs.txt b/doc/test/funcargs.txt similarity index 100% rename from doc/test-funcargs.txt rename to doc/test/funcargs.txt diff --git a/doc/test-plugins.txt b/doc/test/plugins.txt similarity index 100% rename from doc/test-plugins.txt rename to doc/test/plugins.txt diff --git a/doc/test-quickstart.txt b/doc/test/quickstart.txt similarity index 96% rename from doc/test-quickstart.txt rename to doc/test/quickstart.txt index 0430fde91..84a30d5a2 100644 --- a/doc/test-quickstart.txt +++ b/doc/test/quickstart.txt @@ -53,7 +53,7 @@ Python test module is inspected for test methods starting with ``test_``. Please refer to `features`_ for a walk through the basic features. -.. _download: download.html -.. _features: test-features.html +.. _download: ../download.html +.. _features: features.html diff --git a/doc/test-statemanage.txt b/doc/test/statemanage.txt similarity index 100% rename from doc/test-statemanage.txt rename to doc/test/statemanage.txt diff --git a/doc/test.txt b/doc/test/test.txt similarity index 52% rename from doc/test.txt rename to doc/test/test.txt index f98a9a9b8..b558c0064 100644 --- a/doc/test.txt +++ b/doc/test/test.txt @@ -5,7 +5,7 @@ py.test * rapidly collect and run tests * use unit- or doctests, functional or integration tests * distribute tests to multiple environments -* local or global plugins for custom test types +* local or global plugins for custom test scenarios and types quickstart_: for getting started immediately. @@ -17,24 +17,10 @@ extend_: writing plugins and advanced configuration. `distributed testing`_ how to distribute test runs to other machines and platforms. -.. _quickstart: test-quickstart.html -.. _features: test-features.html -.. _plugins: test-plugins.html -.. _extend: test-ext.html -.. _`distributed testing`: test-dist.html +.. _quickstart: quickstart.html +.. _features: features.html +.. _plugins: plugins.html +.. _extend: ext.html +.. _`distributed testing`: dist.html -Contents: - -.. toctree:: - :maxdepth: 2 - - test-quickstart - test-features - test-plugins - test-ext - test-dist - test-config - test-statemanage - test-examples - impl-test diff --git a/doc/xml.txt b/doc/xml.txt index 96db72aaf..cf9ceeca0 100644 --- a/doc/xml.txt +++ b/doc/xml.txt @@ -166,4 +166,4 @@ complete the probably request-specific serialization of your Tags. Hum, it's probably harder to explain this than to actually code it :-) -.. _`py.test`: test.html +.. _`py.test`: test/test.html