From dc73d5573e6c415fd5589309875221343755fa7b Mon Sep 17 00:00:00 2001 From: Chris Dent Date: Wed, 24 Oct 2018 13:37:51 +0100 Subject: Prepare docs for publishing to RTFD We'd like to have a stable location for documentation. The destination will be https://pythonpaste.readthedocs.io This change also tries to make sure that there are sufficient warnings throughout about the status of Paste. --- .gitignore | 1 + docs/_static/default.css | 394 ++++++++++++++++++++++++++++++++++++++ docs/_templates/layout.html | 29 --- docs/community/index.txt | 4 + docs/community/mailing-list.txt | 4 + docs/community/repository.txt | 9 +- docs/conf.py | 2 +- docs/default.css | 394 -------------------------------------- docs/do-it-yourself-framework.txt | 2 +- docs/download/index.txt | 13 +- docs/future.txt | 2 +- docs/index.txt | 8 + setup.py | 6 +- 13 files changed, 426 insertions(+), 442 deletions(-) create mode 100644 docs/_static/default.css delete mode 100644 docs/_templates/layout.html delete mode 100644 docs/default.css diff --git a/.gitignore b/.gitignore index 6b57a05..5689180 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ .tox .coverage *.egg-info +docs/_build/ diff --git a/docs/_static/default.css b/docs/_static/default.css new file mode 100644 index 0000000..a570fb6 --- /dev/null +++ b/docs/_static/default.css @@ -0,0 +1,394 @@ +/* +:Author: David Goodger, Ian Bicking +:Contact: ianb@colorstudy.com +:date: $Date: 2003/11/01 20:35:45 $ +:version: $Revision: 1.3 $ +:copyright: This stylesheet has been placed in the public domain. + +A modification of the default cascading style sheet (v.1.3) for the +HTML output of Docutils. +*/ + +body { + font-family: Arial, sans-serif; + background-color: #fff; +} + +em, i { + /* Typically serif fonts have much nicer italics */ + font-family: Times New Roman, Times, serif; +} + +li { + list-style-type: circle; +} + +a.target { + color: blue; +} + +a.toc-backref { + text-decoration: none; + color: black; +} + +a.toc-backref:hover { + background-color: inherit; +} + +a:hover { + background-color: #ccc; +} + +h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6:hover { + background-color: inherit; +} + +cite { + font-style: normal; + font-family: monospace; + font-weight: bold; +} + +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 { + background-color: #ccc; + width: 40%; + border: medium outset; + padding: 3px; + float: right +} + +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: #c00; + font-weight: bold; + font-family: sans-serif; + text-align: center; + background-color: #999; + display: block; + margin: 0; +} + +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; + text-align: center; + background-color: #999; + display: block; + margin: 0; +} + +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, h2, h3, h4, h5, h6 { + font-family: Helvetica, Arial, sans-serif; + border: thin solid black; + /* This makes the borders rounded on Mozilla, which pleases me */ + -moz-border-radius: 8px; + padding: 4px; +} + +h1 { + background-color: #449; + color: #fff; + border: medium solid black; +} + +h1 a.toc-backref, h2 a.toc-backref { + color: #fff; +} + +h2 { + background-color: #666; + color: #fff; + border: medium solid black; +} + +h3, h4, h5, h6 { + background-color: #ccc; + color: #000; +} + +h3 a.toc-backref, h4 a.toc-backref, h5 a.toc-backref, +h6 a.toc-backref { + color: #000; +} + +h1.title { + text-align: center; + background-color: #449; + color: #fff; + border: thick solid black; + -moz-border-radius: 20px; +} + +h2.subtitle { + text-align: center; +} + +hr { + width: 75%; +} + +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; +} + +p.caption { + font-style: italic; +} + +p.credits { + font-style: italic; + font-size: smaller; +} + +p.first { + margin-top: 0; +} + +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: #eee; + border: thin black solid; + padding: 5px; +} + +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-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; +} + +td > p:first-child, th > p:first-child { + margin-top: 0em; +} + +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%; +} + +code, tt { + color: #006; +} + +ul.auto-toc { + list-style-type: none; +} + +/***************************************** + * Doctest embedded examples + *****************************************/ + +span.doctest-url { + background-color: #eee; + border-top: 2px outset #666; + border-left: 2px outset #666; + border-right: 2px outset #666; + padding: 0.25em; +} + +div.doctest-example { + border: outset 5px #666; + background-color: #eee; + font-family: default; + padding: 0.5em; +} + +div.doctest-example h1 { + background-color: inherit; + border: none; + color: inherit; + font-family: default; +} + +div.doctest-example tt { + color: inherit; +} + +div.doctest-status { + background-color: #060; + color: #fff; +} + +span.doctest-header { + background-color: #ccc; + font-family: monospace; +} + +pre.doctest-errors { + border: none; + background-color: #333; + color: #600; +} + +div.source-code { + background-color: #000; + border: inset #999 3px; + overflow: auto; +} + +pre.source-code { + background-color: #000; + border: inset #999 3px; + overflow: auto; + font-family: monospace; + color: #fff; +} + +span.source-filename { + background-color: #000; + border-top: 2px outset #999; + border-left: 2px outset #999; + border-right: 2px outset #999; + padding: 0.25em; + color: #fff +} + diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html deleted file mode 100644 index 6ae2d42..0000000 --- a/docs/_templates/layout.html +++ /dev/null @@ -1,29 +0,0 @@ -{% extends "!layout.html" %} - -{% block extrahead %} -{{ super() }} - -{% endblock %} - -{% block sidebartoc %} -

Python Paste

- - - -{{ super() }} -{% endblock %} diff --git a/docs/community/index.txt b/docs/community/index.txt index 5b30110..5b7c663 100644 --- a/docs/community/index.txt +++ b/docs/community/index.txt @@ -1,6 +1,10 @@ Community ========= +**Much of the Paste community has moved on to other things. These +links are left for reference, but do not expect to find much activity +there.** + Much of the communication goes on in the `mailing lists `_; see that page for information on the lists. diff --git a/docs/community/mailing-list.txt b/docs/community/mailing-list.txt index 854ec3e..adf1633 100644 --- a/docs/community/mailing-list.txt +++ b/docs/community/mailing-list.txt @@ -1,6 +1,10 @@ Mailing Lists ============= +**Much of the Paste community has moved on to other things. These +links are left for reference, but do not expect to find much activity +there.** + General discussion and questions should go to: `paste-users@googlegroups.org `_: diff --git a/docs/community/repository.txt b/docs/community/repository.txt index b8f3700..5428bf9 100644 --- a/docs/community/repository.txt +++ b/docs/community/repository.txt @@ -1,10 +1,7 @@ Repository ========== -Paste is kept in a Mercurial (hg) repository at -http://bitbucket.org/ianb/paste +Paste is kept in a Git repository at +http://github.com/cdent/paste -If you are using a command-line Mercurial client, you can check -it out like:: - - hg clone http://bitbucket.org/ianb/paste +Go there to make pull requests and report issues. diff --git a/docs/conf.py b/docs/conf.py index e035d50..a2a2f86 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,7 @@ import sys extensions = ['sphinx.ext.autodoc'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +# templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.txt' diff --git a/docs/default.css b/docs/default.css deleted file mode 100644 index a570fb6..0000000 --- a/docs/default.css +++ /dev/null @@ -1,394 +0,0 @@ -/* -:Author: David Goodger, Ian Bicking -:Contact: ianb@colorstudy.com -:date: $Date: 2003/11/01 20:35:45 $ -:version: $Revision: 1.3 $ -:copyright: This stylesheet has been placed in the public domain. - -A modification of the default cascading style sheet (v.1.3) for the -HTML output of Docutils. -*/ - -body { - font-family: Arial, sans-serif; - background-color: #fff; -} - -em, i { - /* Typically serif fonts have much nicer italics */ - font-family: Times New Roman, Times, serif; -} - -li { - list-style-type: circle; -} - -a.target { - color: blue; -} - -a.toc-backref { - text-decoration: none; - color: black; -} - -a.toc-backref:hover { - background-color: inherit; -} - -a:hover { - background-color: #ccc; -} - -h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6:hover { - background-color: inherit; -} - -cite { - font-style: normal; - font-family: monospace; - font-weight: bold; -} - -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 { - background-color: #ccc; - width: 40%; - border: medium outset; - padding: 3px; - float: right -} - -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: #c00; - font-weight: bold; - font-family: sans-serif; - text-align: center; - background-color: #999; - display: block; - margin: 0; -} - -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; - text-align: center; - background-color: #999; - display: block; - margin: 0; -} - -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, h2, h3, h4, h5, h6 { - font-family: Helvetica, Arial, sans-serif; - border: thin solid black; - /* This makes the borders rounded on Mozilla, which pleases me */ - -moz-border-radius: 8px; - padding: 4px; -} - -h1 { - background-color: #449; - color: #fff; - border: medium solid black; -} - -h1 a.toc-backref, h2 a.toc-backref { - color: #fff; -} - -h2 { - background-color: #666; - color: #fff; - border: medium solid black; -} - -h3, h4, h5, h6 { - background-color: #ccc; - color: #000; -} - -h3 a.toc-backref, h4 a.toc-backref, h5 a.toc-backref, -h6 a.toc-backref { - color: #000; -} - -h1.title { - text-align: center; - background-color: #449; - color: #fff; - border: thick solid black; - -moz-border-radius: 20px; -} - -h2.subtitle { - text-align: center; -} - -hr { - width: 75%; -} - -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; -} - -p.caption { - font-style: italic; -} - -p.credits { - font-style: italic; - font-size: smaller; -} - -p.first { - margin-top: 0; -} - -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: #eee; - border: thin black solid; - padding: 5px; -} - -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-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; -} - -td > p:first-child, th > p:first-child { - margin-top: 0em; -} - -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%; -} - -code, tt { - color: #006; -} - -ul.auto-toc { - list-style-type: none; -} - -/***************************************** - * Doctest embedded examples - *****************************************/ - -span.doctest-url { - background-color: #eee; - border-top: 2px outset #666; - border-left: 2px outset #666; - border-right: 2px outset #666; - padding: 0.25em; -} - -div.doctest-example { - border: outset 5px #666; - background-color: #eee; - font-family: default; - padding: 0.5em; -} - -div.doctest-example h1 { - background-color: inherit; - border: none; - color: inherit; - font-family: default; -} - -div.doctest-example tt { - color: inherit; -} - -div.doctest-status { - background-color: #060; - color: #fff; -} - -span.doctest-header { - background-color: #ccc; - font-family: monospace; -} - -pre.doctest-errors { - border: none; - background-color: #333; - color: #600; -} - -div.source-code { - background-color: #000; - border: inset #999 3px; - overflow: auto; -} - -pre.source-code { - background-color: #000; - border: inset #999 3px; - overflow: auto; - font-family: monospace; - color: #fff; -} - -span.source-filename { - background-color: #000; - border-top: 2px outset #999; - border-left: 2px outset #999; - border-right: 2px outset #999; - padding: 0.25em; - color: #fff -} - diff --git a/docs/do-it-yourself-framework.txt b/docs/do-it-yourself-framework.txt index ae77ec0..23b85ae 100644 --- a/docs/do-it-yourself-framework.txt +++ b/docs/do-it-yourself-framework.txt @@ -387,7 +387,7 @@ is a somewhat more thorough implementation of this. This, like a lot of parts of this (now fairly old) tutorial is better, more thorough, and easier using `WebOb - `_. This particular example looks + `_. This particular example looks like:: from webob import Request diff --git a/docs/download/index.txt b/docs/download/index.txt index 01f918f..537e316 100644 --- a/docs/download/index.txt +++ b/docs/download/index.txt @@ -16,17 +16,16 @@ are always located on the Cheese Shop pages (listed below). * `Wareweb `_ (deprecated, use `Pylons `_ instead) -All the packages are available in the Mercurial repositories rooted in +All the packages are available in some repositories, many rooted in http://bitbucket.org/ianb/ -* http://bitbucket.org/ianb/paste +* https://github.com/cdent/paste * http://bitbucket.org/ianb/pastescript * http://bitbucket.org/ianb/pastedeploy * https://github.com/Pylons/webob * ... and others -Use:: - - hg clone http://bitbucket.org/ianb/paste - -to check out a working copy of Paste. +..note:: Several of these repositories and projects are fairly stale and + insufficiently maintained. Work is in progress to get them on + life support, but it is unlikely they will ever be active projects + again. WebOb is still actively maintained. diff --git a/docs/future.txt b/docs/future.txt index 697c750..d98775f 100644 --- a/docs/future.txt +++ b/docs/future.txt @@ -4,7 +4,7 @@ The Future Of Paste Introduction ------------ -Paste has been under development for a while, and has lots of code in it. Too much code! The code is largely decoupled except for some core functions shared by many parts of the code. Those core functions are largely replaced in `WebOb `_, and replaced with better implementations. +Paste has been under development for a while, and has lots of code in it. Too much code! The code is largely decoupled except for some core functions shared by many parts of the code. Those core functions are largely replaced in `WebOb `_, and replaced with better implementations. The future of these pieces is to split them into independent packages, and refactor the internal Paste dependencies to rely instead on WebOb. diff --git a/docs/index.txt b/docs/index.txt index 546e9fb..a202b9d 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -1,6 +1,14 @@ Python Paste ============ +This is a new copy of the documentation for Paste. The project is now being +maintained on limited life-support from https://github.com/cdent/paste +**Please consider other options.** + +Many of the links you will find in these docs will be out of date. If you +know of a better destination for a link please submit an issue or pull +request at the GitHub repository above. + Contents: .. toctree:: diff --git a/setup.py b/setup.py index d023e23..ab8ed29 100644 --- a/setup.py +++ b/setup.py @@ -49,9 +49,9 @@ setup(name="Paste", "Framework :: Paste", ], keywords='web application server wsgi', - author="Ian Bicking", - author_email="ianb@colorstudy.com", - url="https://pypi.org/project/Paste/", + author="Chris Dent", + author_email="chris.dent@gmail.com", + url="https://pythonpaste.readthedocs.io/", license="MIT", packages=find_packages(exclude=['ez_setup', 'examples', 'packages', 'tests*']), package_data=finddata.find_package_data( -- cgit v1.2.1