diff options
| author | wiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2006-01-09 20:44:25 +0000 |
|---|---|---|
| committer | wiemann <wiemann@929543f6-e4f2-0310-98a6-ba3bd3dd1d04> | 2006-01-09 20:44:25 +0000 |
| commit | d77fdfef70e08114f57cbef5d91707df8717ea9f (patch) | |
| tree | 49444e3486c0c333cb7b33dfa721296c08ee4ece /web | |
| parent | 53cd16ca6ca5f638cbe5956988e88f9339e355cf (diff) | |
| parent | 3993c4097756e9885bcfbd07cb1cc1e4e95e50e4 (diff) | |
| download | docutils-0.4.tar.gz | |
Release 0.4: tagging released revisiondocutils-0.4
git-svn-id: http://svn.code.sf.net/p/docutils/code/tags/docutils-0.4@4268 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'web')
| -rw-r--r-- | web/.htaccess | 62 | ||||
| -rw-r--r-- | web/PyBanner016.png | bin | 720 -> 0 bytes | |||
| -rw-r--r-- | web/index.txt | 148 | ||||
| -rw-r--r-- | web/mirror/setext.txt | 27 | ||||
| -rw-r--r-- | web/python.png | bin | 4846 -> 0 bytes | |||
| -rw-r--r-- | web/rst.png | bin | 1171 -> 0 bytes | |||
| -rw-r--r-- | web/rst.txt | 234 |
7 files changed, 0 insertions, 471 deletions
diff --git a/web/.htaccess b/web/.htaccess deleted file mode 100644 index adb439505..000000000 --- a/web/.htaccess +++ /dev/null @@ -1,62 +0,0 @@ -# Do not edit arbitrarily. Check with docutils-develop@lists.sf.net first. - -# Moved files and directories. - -Redirect permanent docs/ref/rst/substitutions.html http://docutils.sourceforge.net/docs/ref/rst/definitions.html -Redirect permanent docs/ref/rst/substitutions.txt http://docutils.sourceforge.net/docs/ref/rst/definitions.txt -Redirect permanent /sandbox/felixwiemann http://docutils.sourceforge.net/sandbox/fwiemann - -# Redirect snapshots to BerliOS. The target URL may change in the -# future, so use a temporary redirect (status 302). - -RedirectMatch temp /(.*-snapshot.tgz) ftp://ftp.berlios.de/pub/docutils/$1 - -# Redirection from old URLs to new URLs after a site reorganization. - -Redirect permanent /docs/config.html http://docutils.sourceforge.net/docs/user/config.html -Redirect permanent /docs/config.txt http://docutils.sourceforge.net/docs/user/config.txt -Redirect permanent /docs/latex.html http://docutils.sourceforge.net/docs/user/latex.html -Redirect permanent /docs/latex.txt http://docutils.sourceforge.net/docs/user/latex.txt -Redirect permanent /docs/tools.html http://docutils.sourceforge.net/docs/user/tools.html -Redirect permanent /docs/tools.txt http://docutils.sourceforge.net/docs/user/tools.txt - -Redirect permanent /docs/rst/ http://docutils.sourceforge.net/docs/user/rst/ - -Redirect permanent /spec/howto/ http://docutils.sourceforge.net/docs/howto/ - -Redirect permanent /spec/pysource.dtd http://docutils.sourceforge.net/docs/dev/pysource.dtd -Redirect permanent /spec/pysource.txt http://docutils.sourceforge.net/docs/dev/pysource.txt -Redirect permanent /spec/pysource.html http://docutils.sourceforge.net/docs/dev/pysource.html -Redirect permanent /spec/semantics.txt http://docutils.sourceforge.net/docs/dev/semantics.txt -Redirect permanent /spec/semantics.html http://docutils.sourceforge.net/docs/dev/semantics.html -Redirect permanent /spec/notes.txt http://docutils.sourceforge.net/docs/dev/todo.txt -Redirect permanent /spec/notes.html http://docutils.sourceforge.net/docs/dev/todo.html - -Redirect permanent /spec/doctree.txt http://docutils.sourceforge.net/docs/ref/doctree.txt -Redirect permanent /spec/doctree.html http://docutils.sourceforge.net/docs/ref/doctree.html -Redirect permanent /spec/docutils.dtd http://docutils.sourceforge.net/docs/ref/docutils.dtd -Redirect permanent /spec/soextblx.dtd http://docutils.sourceforge.net/docs/ref/soextblx.dtd - -Redirect permanent /spec/transforms.txt http://docutils.sourceforge.net/docs/ref/transforms.txt -Redirect permanent /spec/transforms.html http://docutils.sourceforge.net/docs/ref/transforms.html - -Redirect permanent /spec/rst/alternatives.txt http://docutils.sourceforge.net/docs/dev/rst/alternatives.txt -Redirect permanent /spec/rst/alternatives.html http://docutils.sourceforge.net/docs/dev/rst/alternatives.html -Redirect permanent /spec/rst/problems.txt http://docutils.sourceforge.net/docs/dev/rst/problems.txt -Redirect permanent /spec/rst/problems.html http://docutils.sourceforge.net/docs/dev/rst/problems.html - -Redirect permanent /spec/rst/reStructuredText.txt http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.txt -Redirect permanent /spec/rst/reStructuredText.html http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html -Redirect permanent /spec/rst/restructuredtext.txt http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.txt -Redirect permanent /spec/rst/restructuredtext.html http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html -Redirect permanent /spec/rst/directives.txt http://docutils.sourceforge.net/docs/ref/rst/directives.txt -Redirect permanent /spec/rst/directives.html http://docutils.sourceforge.net/docs/ref/rst/directives.html -Redirect permanent /spec/rst/interpreted.txt http://docutils.sourceforge.net/docs/ref/rst/roles.txt -Redirect permanent /spec/rst/interpreted.html http://docutils.sourceforge.net/docs/ref/rst/roles.html -Redirect permanent /spec/rst/introduction.txt http://docutils.sourceforge.net/docs/ref/rst/introduction.txt -Redirect permanent /spec/rst/introduction.html http://docutils.sourceforge.net/docs/ref/rst/introduction.html - -RedirectMatch permanent /spec/pep-(.*) http://docutils.sourceforge.net/docs/peps/pep-$1 - -Redirect permanent /tools/test.txt http://docutils.sourceforge.net/docs/user/rst/demo.txt -Redirect permanent /tools/test.html http://docutils.sourceforge.net/docs/user/rst/demo.html diff --git a/web/PyBanner016.png b/web/PyBanner016.png Binary files differdeleted file mode 100644 index 3c79b2ef7..000000000 --- a/web/PyBanner016.png +++ /dev/null diff --git a/web/index.txt b/web/index.txt deleted file mode 100644 index 0ede85268..000000000 --- a/web/index.txt +++ /dev/null @@ -1,148 +0,0 @@ -=================================== - Docutils: Documentation Utilities -=================================== ---------------------------------------------------------- - Written in Python, for General- and Special-Purpose Use ---------------------------------------------------------- - -Docutils is an open-source text processing system for processing -plaintext documentation into useful formats, such as HTML or LaTeX. -It includes reStructuredText_, the easy to read, easy to use, -what-you-see-is-what-you-get plaintext markup language. - ----------------------------------------------------------------------- - -**To get up & running quickly**, see the Quick-Start_ section of the -README_ file. - -All **documentation** can be reached from the `Docutils Project -Documentation Overview`_. - -To the developers of an open source project, **feedback** is a great -motivator and is very welcome. We also rely on feedback for -determining what features to implement. Thus, if you tell us what you -need, you may just get it! Please post any feedback to the -Docutils-users_ mailing list. - -All **discussion** about Docutils takes place on the `mailing lists`_. - -If you find a **bug**, please file a `bug report`_ or send email to -the Docutils-users_ mailing list. **Patch** submissions should be -filed in the `patch tracker`_ or sent to Docutils-develop_. - -We welcome all kinds of **contributions**. There's a `To Do list`_ -full of interesting ideas awaiting a champion. If you have any -questions regarding how to extend Docutils, please feel free to ask on -the Docutils-develop_ mailing list. Please also consider **donating** -to Docutils: |donate|. - -The only **requirement** for running Docutils is Python_ 2.2 or later. -(Python 2.1 may be used providing the compiler package is installed. -The compiler package can be found in the Tools/ directory of Python's -source distribution.) - -Docutils is in active development and should be considered **highly -experimental**. APIs are subject to change at any time. - - -Download -======== - -We recommend that you use the latest **snapshot**, -`<docutils-snapshot.tgz>`_. The snapshots usually contain *more -features* and *fewer bugs* than the "official" releases |---| they're -not only for developers! - -The latest **release package** is `docutils-0.3.9.tgz`__. It has been -released on 2005-05-26 and is mostly intended for distributors. See -the `announcement posting`_ for a list of changes since the previous -release (0.3.7). - -__ http://prdownloads.sourceforge.net/docutils/docutils-0.3.9.tar.gz?download -.. _announcement posting: - http://article.gmane.org/gmane.text.docutils.user/2054 - -More snapshots: - -- `Snapshot of the Sandbox`_ (experimental, contributed code; see the - Sandbox_ for details) -- `Snapshot of DocFactory project files`_ (this is a subset of the - Sandbox snapshot above; you don't need both) - -You can also access `Docutils' Subversion repository`_ directly. - -.. class:: credits - -Web site, tracker and mailing lists hosted by |SourceForge|_. -Subversion repository hosted by |BerliOS|_. -Powered by |Python|_. - -.. class:: hidden - -Google should index the mailing lists: `Docutils-users -<http://news.gmane.org/group/gmane.text.docutils.user/last=/force_load=t>`__, -`Docutils-develop -<http://news.gmane.org/group/gmane.text.docutils.devel/last=/force_load=t>`__, -and `Docutils-checkins -<http://news.gmane.org/group/gmane.text.docutils.cvs/last=/force_load=t>`__. - -.. |---| unicode:: U+02014 .. em dash - :trim: -.. _latest snapshot: http://docutils.sourceforge.net/docutils-snapshot.tgz -.. _Snapshot of the Sandbox: - http://docutils.sourceforge.net/docutils-sandbox-snapshot.tgz -.. _Snapshot of DocFactory project files: - http://docutils.sourceforge.net/docfactory-snapshot.tgz -.. _bug report: http://sourceforge.net/tracker/?group_id=38414&atid=422030 -.. _patch tracker: http://sourceforge.net/tracker/?group_id=38414&atid=422032 -.. _mailing lists: docs/user/mailing-lists.html -.. _Docutils-users: docs/user/mailing-lists.html#docutils-users -.. _Docutils-develop: docs/user/mailing-lists.html#docutils-develop -.. _sandbox: sandbox/README.html -.. _reStructuredText: rst.html -.. _project files page: - http://sourceforge.net/project/showfiles.php?group_id=38414 -.. _To Do list: docs/dev/todo.html -.. _README: README.html -.. _Quick-Start: README.html#quick-start -.. _Docutils Project Documentation Overview: docs/index.html -.. _Docutils' Subversion repository: docs/dev/repository.html -.. |donate| image:: http://images.sourceforge.net/images/project-support.jpg - :target: http://sourceforge.net/donate/index.php?group_id=38414 - :align: middle - :width: 88 - :height: 32 - :alt: Support the Docutils project! -.. |SourceForge| image:: - http://sourceforge.net/sflogo.php?group_id=38414 - :alt: SourceForge Logo - :align: middle - :class: borderless - :width: 88 - :height: 31 -.. |BerliOS| image:: - http://developer.berlios.de/sflogo.php?group_id=2920 - :alt: BerliOS Logo - :align: middle - :class: borderless - :width: 124 - :height: 32 -.. |Python| image:: python.png - :alt: Python Logo - :align: middle - :class: borderless - :width: 193 - :height: 32 -.. _BerliOS: http://developer.berlios.de/ -.. _SourceForge: http://sourceforge.net/ -.. _Python: http://www.python.org/ - - - -.. - Local Variables: - mode: indented-text - indent-tabs-mode: nil - sentence-end-double-space: t - fill-column: 70 - End: diff --git a/web/mirror/setext.txt b/web/mirror/setext.txt deleted file mode 100644 index 48d0ee6db..000000000 --- a/web/mirror/setext.txt +++ /dev/null @@ -1,27 +0,0 @@ -========================= - Setext Documents Mirror -========================= - -Here are `local copies of some Setext documents`__, made available to -document the prehistory of the Docutils_ project (and especially the -reStructuredText_ markup). - -__ -.. _Setext mirror: setext/ -.. _Docutils: ../ -.. _reStructuredText: ../rst.html - -The source for the original Setext (structure-enhanced text) documents -was http://www.bsdi.com/setext/, but it seems to have disappeared from -the Web. The files in the "`Setext mirror`_" are all the files -relating to Setext that I have (including `a tarball of the lot`__). - -__ setext/setext.tgz - -I have not been able to locate the originators of Setext, Ian Feldman -or Tony Sanders. If you know how to contact them, or if you know of -an official repository for the Setext documents, please `inform me`__. - -__ mailto:goodger@users.sourceforge.net - -David Goodger, 2002-03-25 diff --git a/web/python.png b/web/python.png Binary files differdeleted file mode 100644 index ba92bf33a..000000000 --- a/web/python.png +++ /dev/null diff --git a/web/rst.png b/web/rst.png Binary files differdeleted file mode 100644 index cc6218efe..000000000 --- a/web/rst.png +++ /dev/null diff --git a/web/rst.txt b/web/rst.txt deleted file mode 100644 index 1d0de417a..000000000 --- a/web/rst.txt +++ /dev/null @@ -1,234 +0,0 @@ -==================== - |reStructuredText| -==================== -------------------------------------------------- - Markup Syntax and Parser Component of Docutils_ -------------------------------------------------- - -:Date: $Date$ - -.. contents:: - -reStructuredText is an easy-to-read, what-you-see-is-what-you-get -plaintext markup syntax and parser system. It is useful for in-line -program documentation (such as Python docstrings), for quickly -creating simple web pages, and for standalone documents. -reStructuredText is designed for extensibility for specific -application domains. The reStructuredText parser is a component of -Docutils_. reStructuredText is a revision and reinterpretation of the -StructuredText_ and Setext_ lightweight markup systems. - -The primary goal of reStructuredText is to define and implement a -markup syntax for use in Python docstrings and other documentation -domains, that is readable and simple, yet powerful enough for -non-trivial use. The intended purpose of the markup is the conversion -of reStructuredText documents into useful structured data formats. - -See statemachine.py_ for an example of a Python module fully -documented using reStructuredText. - - -User Documentation -================== - -- `A ReStructuredText Primer`__ (HTML file, or `text source`__). -- `Quick reStructuredText`__ (user reference) -- `reStructuredText Cheat Sheet`__ (text only; 1 page for syntax, 1 - page directive & role reference) - -Users who have questions or need assistance with Docutils or -reStructuredText should post a message to the Docutils-users_ mailing -list. - -__ docs/user/rst/quickstart.html -__ docs/user/rst/quickstart.txt -__ docs/user/rst/quickref.html -__ docs/user/rst/cheatsheet.txt -.. _Docutils-users: docs/user/mailing-lists.html#docutils-users - - -Reference Documentation -======================= - -- `An Introduction to reStructuredText`__ (includes the Goals__ and - History__ of reStructuredText) -- `reStructuredText Markup Specification`__ -- `reStructuredText Directives`__ -- `reStructuredText Interpreted Text Roles`__ - -__ docs/ref/rst/introduction.html -__ docs/ref/rst/introduction.html#goals -__ docs/ref/rst/introduction.html#history -__ docs/ref/rst/restructuredtext.html -__ docs/ref/rst/directives.html -__ docs/ref/rst/roles.html - - -Developer Documentation -======================= - -- `A Record of reStructuredText Syntax Alternatives`__ -- `Problems With StructuredText`__ - -__ docs/dev/rst/alternatives.html -__ docs/dev/rst/problems.html - - -How-To's --------- - -- `Creating reStructuredText Directives`__ -- `Creating reStructuredText Interpreted Text Roles`__ - -__ docs/howto/rst-directives.html -__ docs/howto/rst-roles.html - - -Testimonials -============ - -The following testimonials are excerpts from unsolicited posts to -mailing lists and the comp.lang.python newsgroup. Being excerpts, -there's often context missing, which sometimes tones down the message. - -`Ueli Schlaepfer on Doc-SIG, 2002-03-28`__: - -__ http://mail.python.org/pipermail/doc-sig/2002-March/002526.html - - I have adopted reST as my tool of choice for producing notes while - doing lab work (mostly in a matlab environment). Since then, the - quality of such documentation has increased noticeably, mostly for - two reasons: - - - I no longer need to switch to another tool, so the threshold has - fallen to very low. Note that "another tool" means Winword... - - Still, I have a powerful set of markup constructs at my - fingertips that let me create the kind of documents I need with - more ease than any other tool I can think of. - - Thanks to reST/DPS [now Docutils --ed], I'll soon be able to go - ahead and apply the same tools for extracting documentation out of - my Python code. Hey, that's a printable and a browsable version - *for free*! Personally, I consider this a large benefit. - - ... All essential constructs for everyday use are there, and much - more if needed. ... - -`Guido van Rossum, enthusiastic about PEP 287 but a bit hasty (see the -follow-ups) on Python-Dev, 2002-04-02`__: - -__ http://mail.python.org/pipermail/python-dev/2002-April/022131.html - - Good PEP, David! What's the next step? Should the processing - code be incorporated in the standard library? Should we start - converting the standard library docs to reStructuredText? - -`Timothy Delaney on comp.lang.python, 2002-04-03`__: - -__ http://mail.python.org/pipermail/python-list/2002-April/096013.html - - I read through all the reStructuredText docs, comparing the text - versions to the html versions. I found the text versions to be - *very* easy to read, whilst making it obvious in most cases when - something was "special". - - I particularly like the system of doing hyperlinks... - - Definitely +1 from me ... I would really like a standard, clean - docstring format. Might make it easier to get my next project - done in Python... - -`Guido van Rossum on Python-Dev, 2002-04-03`__: - -__ http://mail.python.org/pipermail/python-dev/2002-April/022212.html - - I think that reStructuredText is a good format for marking up - docstrings; it's probably as good as it gets given the - requirements (a fairly elaborate feature set, yet more readable - "in the raw" than HTML). - -`Richard Jones on comp.lang.python, 2002-04-03`__: - -__ http://mail.python.org/pipermail/python-list/2002-April/096117.html - - How I see it is that ReST is a middle ground between markup and - non-. It has markup, and you can use it to the extreme. Or you - can follow some simple conventions (the most basic form of markup) - and not worry about all the finer detail stuff. The difference - between:: - - @section{The Section Title} - - and:: - - The Section Title - ----------------- - - Is pretty clearly to me that the second doesn't *look* like - markup, even though it is. - -`Guido van Rossum on Python-Dev, 2002-04-04`__: - -__ http://mail.python.org/pipermail/python-dev/2002-April/022247.html - - Structured text is really a great idea for certain situations; - reST is a much better implementation of the idea than any versions - I've seen before. - -`Max M on comp.lang.python, 2002-04-05`__: - -__ http://mail.python.org/pipermail/python-list/2002-April/096656.html - - Any programmer can learn the basics in 15 minutes or less. - - And it really is very very easy to write documents in it. I do - belive that if I were ever to write a book (again) I would write - it in ReST. - - And as far as I can tell from the specs, ReST solves most of the - problems I have had with structured text. A few things gets a - little more complicated and some get simpler. All in all a good - bargain. - - I would certainly use it. I also hope that it gets integrated - into Zope. - -`David Abrahams on Python-Dev, 2002-04-06`__: - -__ http://mail.python.org/pipermail/python-dev/2002-April/022443.html - - Incidentally, I'm really excited about reST. I've been looking - for a tolerable markup for C++ comments, and reST looks like it - might fit the bill. - -`Eric Jones on Python-Dev, 2002-08-01`__: - -__ http://mail.python.org/pipermail/python-dev/2002-August/027198.html - - I would very much like to see reStructuredText, or some minor - variation on it, move forward as a "standard" for doc-strings very - soon. I have long lamented not having a prescribed format *and* - an associated processing tool suite included in the standard - library. Even if the format isn't perfect (I think it looks very - good), it is time to pick a reasonable candidate and go. - -This being the Internet, there were plenty of people opposed to the -idea of reStructuredText, some vehemently. Discovering *those* gems -is left as an exercise for the reader. - -.. _Docutils: index.html -.. _StructuredText: - http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage/ -.. _Setext: mirror/setext.html -.. _statemachine.py: docutils/statemachine.py - -.. |reStructuredText| image:: rst.png - - -.. - Local Variables: - mode: indented-text - indent-tabs-mode: nil - sentence-end-double-space: t - fill-column: 70 - End: |
