diff --git a/doc/_static/pocoo.png b/doc/_static/pocoo.png index 297dcd5e0..eeb18eafe 100644 Binary files a/doc/_static/pocoo.png and b/doc/_static/pocoo.png differ diff --git a/doc/_templates/index.html b/doc/_templates/index.html index 34dead7e6..cd6c535ca 100644 --- a/doc/_templates/index.html +++ b/doc/_templates/index.html @@ -17,25 +17,23 @@ documentation of Python projects, but C/C++ is already supported as well, and it is planned to add special support for other languages as well. Of course, this site is also created from reStructuredText sources using - Sphinx! -

-

- Sphinx is under constant development. The following features are present, - work fine and can be seen “in action” in the Python docs: + Sphinx! The following features should be highlighted:

Sphinx uses reStructuredText @@ -44,7 +42,7 @@ suite, the Docutils.

-

Documentation

+

Documentation

@@ -86,14 +84,4 @@

There is a Japanese translation of this documentation, thanks to Yoshiki Shibukawa.

-

Get Sphinx

-

- Sphinx is available as an easy-installable - package on the Python Package - Index. -

-

The code can be found in a Mercurial repository, at - http://bitbucket.org/birkenfeld/sphinx/.

- {% endblock %} diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html index feafd9046..ee8ff0182 100644 --- a/doc/_templates/indexsidebar.html +++ b/doc/_templates/indexsidebar.html @@ -1,5 +1,5 @@ - +

Download

{% if version.endswith('(hg)') %} @@ -20,11 +20,12 @@ are also available.

Questions? Suggestions?

-

Join the Google group:

-
- - +

Join the Google group:

+ + +

or come to the #pocoo channel on FreeNode.

You can also open an issue at the diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html deleted file mode 100644 index 6e609e1a1..000000000 --- a/doc/_templates/layout.html +++ /dev/null @@ -1,23 +0,0 @@ -{% extends "!layout.html" %} - -{% block extrahead %} -{{ super() }} -{%- if not embedded %} - -{%- endif %} -{% endblock %} - -{% block rootrellink %} -

  • Sphinx home | 
    • -
  • Documentation - »
    • -{% endblock %} - -{% block header %} -
    -Sphinx logo -
    -{% endblock %} diff --git a/doc/_themes/sphinx13/layout.html b/doc/_themes/sphinx13/layout.html new file mode 100644 index 000000000..69dd37f77 --- /dev/null +++ b/doc/_themes/sphinx13/layout.html @@ -0,0 +1,78 @@ +{# + sphinxdoc/layout.html + ~~~~~~~~~~~~~~~~~~~~~ + + Sphinx layout template for the sphinxdoc theme. + + :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +#} +{%- extends "basic/layout.html" %} + +{# put the sidebar before the body #} +{% block sidebar1 %}{{ sidebar() }}{% endblock %} +{% block sidebar2 %}{% endblock %} + +{% block extrahead %} + +{{ super() }} +{%- if not embedded %} + + +{%- endif %} +{% endblock %} + +{% block rootrellink %} +
  • Sphinx home |
    • +
  • Documentation »
    • +{% endblock %} + +{% block header %} +
    + +
    + + SPHINX + +
    +
    +{% endblock %} diff --git a/doc/_themes/sphinx13/static/bodybg.png b/doc/_themes/sphinx13/static/bodybg.png new file mode 100644 index 000000000..506b6f908 Binary files /dev/null and b/doc/_themes/sphinx13/static/bodybg.png differ diff --git a/doc/_themes/sphinx13/static/footerbg.png b/doc/_themes/sphinx13/static/footerbg.png new file mode 100644 index 000000000..d1922b446 Binary files /dev/null and b/doc/_themes/sphinx13/static/footerbg.png differ diff --git a/doc/_themes/sphinx13/static/headerbg.png b/doc/_themes/sphinx13/static/headerbg.png new file mode 100644 index 000000000..6d3e1d5e6 Binary files /dev/null and b/doc/_themes/sphinx13/static/headerbg.png differ diff --git a/doc/_themes/sphinx13/static/listitem.png b/doc/_themes/sphinx13/static/listitem.png new file mode 100644 index 000000000..e45715f91 Binary files /dev/null and b/doc/_themes/sphinx13/static/listitem.png differ diff --git a/doc/_themes/sphinx13/static/relbg.png b/doc/_themes/sphinx13/static/relbg.png new file mode 100644 index 000000000..47225851b Binary files /dev/null and b/doc/_themes/sphinx13/static/relbg.png differ diff --git a/doc/_themes/sphinx13/static/sphinx13.css b/doc/_themes/sphinx13/static/sphinx13.css new file mode 100644 index 000000000..bb81b67b5 --- /dev/null +++ b/doc/_themes/sphinx13/static/sphinx13.css @@ -0,0 +1,396 @@ +/* + * sphinx13.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- sphinx13 theme. + * + * :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 14px; + text-align: center; + background-image: url(bodybg.png); + color: black; + padding: 0; + border-right: 1px solid #0a507a; + border-left: 1px solid #0a507a; + + margin: 0 auto; + min-width: 780px; + max-width: 1080px; +} + +.pageheader { + background-image: url(headerbg.png); + text-align: left; + padding: 10px 15px; +} + +.pageheader ul { + float: right; + color: white; + list-style-type: none; + padding-left: 0; + margin-top: 30px; + margin-right: 10px; +} + +.pageheader li { + float: left; + margin: 0 0 0 10px; +} + +.pageheader li a { + border-radius: 1px; + padding: 8px 12px; + color: #f9f9f0; + text-shadow: 0 0 5px rgba(0, 0, 0, 0.5); +} + +.pageheader li a:hover { + background-color: #f9f9f0; + color: #0a507a; + text-shadow: none; +} + +div.document { + background-color: white; + text-align: left; +} + +div.bodywrapper { + margin: 0 240px 0 0; + border-right: 1px solid #0a507a; +} + +div.body { + margin: 0; + padding: 0.5em 20px 20px 20px; +} + +div.related { + font-size: 1em; + color: white; +} + +div.related ul { + background-image: url(relbg.png); + height: 1.9em; + border-top: 1px solid #002e50; + border-bottom: 1px solid #002e50; +} + +div.related ul li { + margin: 0 5px 0 0; + padding: 0; + float: left; +} + +div.related ul li.right { + float: right; + margin-right: 5px; +} + +div.related ul li a { + margin: 0; + padding: 0 5px 0 5px; + line-height: 1.75em; + color: #f9f9f0; + text-shadow: 0px 0px 1px rgba(0, 0, 0, 0.5); +} + +div.related ul li a:hover { + color: white; + /*text-decoration: underline;*/ + text-shadow: 0px 0px 1px rgba(255, 255, 255, 0.5); +} + +div.sphinxsidebarwrapper { + position: relative; + top: 0px; + padding: 0; +} + +div.sphinxsidebar { + margin: 0; + padding: 0 15px 15px 0; + width: 210px; + float: right; + font-size: 1em; + text-align: left; +} + +div.sphinxsidebar .logo { + font-size: 1.8em; + color: #0A507A; + font-weight: 300; + text-align: center; +} + +div.sphinxsidebar .logo img { + vertical-align: middle; +} + +div.sphinxsidebar input { + border: 1px solid #aaa; + font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; + font-size: 1em; +} + +div.sphinxsidebar h3 { + font-size: 1.5em; + border-top: 1px solid #0a507a; + margin-top: 1em; + margin-bottom: 0.5em; + padding-top: 0.5em; +} + +div.sphinxsidebar h4 { + font-size: 1.2em; + margin-bottom: 0; +} + +div.sphinxsidebar h3, div.sphinxsidebar h4 { + margin-right: -15px; + margin-left: -15px; + padding-right: 14px; + padding-left: 14px; + color: #333; + font-weight: 300; + /*text-shadow: 0px 0px 0.5px rgba(0, 0, 0, 0.4);*/ +} + +div.sphinxsidebarwrapper > h3:first-child { + margin-top: 0.5em; + border: none; +} + +div.sphinxsidebar h3 a { + color: #333; +} + +div.sphinxsidebar ul { + color: #444; + margin-top: 7px; + padding: 0; + line-height: 130%; +} + +div.sphinxsidebar ul ul { + margin-left: 20px; + list-style-image: url(listitem.png); +} + +div.footer { + background-image: url(footerbg.png); + color: #ccc; + text-shadow: 0 0 .2px rgba(255, 255, 255, 0.8); + padding: 3px 8px 3px 0; + clear: both; + font-size: 0.8em; + text-align: right; +} + +/* no need to make a visible link to Sphinx on the Sphinx page */ +div.footer a { + color: #ccc; +} + +/* -- body styles ----------------------------------------------------------- */ + +p { + margin: 0.8em 0 0.5em 0; +} + +a { + color: #A2881D; + text-decoration: none; +} + +a:hover { + color: #E1C13F; +} + +div.body a { + text-decoration: underline; +} + +h1 { + margin: 10px 0 0 0; + font-size: 2.4em; + color: #0A507A; + font-weight: 300; +} + +h2 { + margin: 1.em 0 0.2em 0; + font-size: 1.5em; + font-weight: 300; + padding: 0; + color: #174967; +} + +h3 { + margin: 1em 0 -0.3em 0; + font-size: 1.3em; + font-weight: 300; +} + +div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a { + text-decoration: none; +} + +div.body h1 a tt, div.body h2 a tt, div.body h3 a tt, div.body h4 a tt, div.body h5 a tt, div.body h6 a tt { + color: #0A507A !important; + font-size: inherit !important; +} + +a.headerlink { + color: #0A507A !important; + font-size: 12px; + margin-left: 6px; + padding: 0 4px 0 4px; + text-decoration: none !important; + float: right; +} + +a.headerlink:hover { + background-color: #ccc; + color: white!important; +} + +cite, code, tt { + font-family: 'Consolas', 'DejaVu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 14px; + letter-spacing: -0.02em; +} + +tt { + background-color: #f2f2f2; + border: 1px solid #ddd; + border-radius: 2px; + color: #333; + padding: 1px; +} + +tt.descname, tt.descclassname, tt.xref { + border: 0; +} + +hr { + border: 1px solid #abc; + margin: 2em; +} + +a tt { + border: 0; + color: #a2881d; +} + +a tt:hover { + color: #e1c13f; +} + +pre { + font-family: 'Consolas', 'DejaVu Sans Mono', + 'Bitstream Vera Sans Mono', monospace; + font-size: 13px; + letter-spacing: 0.015em; + line-height: 120%; + padding: 0.5em; + border: 1px solid #ccc; + border-radius: 2px; + background-color: #f8f8f8; +} + +pre a { + color: inherit; + text-decoration: underline; +} + +td.linenos pre { + padding: 0.5em 0; +} + +div.quotebar { + background-color: #f8f8f8; + max-width: 250px; + float: right; + padding: 0px 7px; + border: 1px solid #ccc; + margin-left: 1em; +} + +div.topic { + background-color: #f8f8f8; +} + +table { + border-collapse: collapse; + margin: 0 -0.5em 0 -0.5em; +} + +table td, table th { + padding: 0.2em 0.5em 0.2em 0.5em; +} + +div.admonition, div.warning { + font-size: 0.9em; + margin: 1em 0 1em 0; + border: 1px solid #86989B; + border-radius: 2px; + background-color: #f7f7f7; + padding: 0; +} + +div.admonition p, div.warning p { + margin: 0.5em 1em 0.5em 1em; + padding: 0; +} + +div.admonition pre, div.warning pre { + margin: 0.4em 1em 0.4em 1em; +} + +div.admonition p.admonition-title, +div.warning p.admonition-title { + margin-top: 1em; + padding-top: 0.5em; + font-weight: bold; +} + +div.warning { + border: 1px solid #940000; +/* background-color: #FFCCCF;*/ +} + +div.warning p.admonition-title { +} + +div.admonition ul, div.admonition ol, +div.warning ul, div.warning ol { + margin: 0.1em 0.5em 0.5em 3em; + padding: 0; +} + +.viewcode-back { + font-family: 'Open Sans', 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva', + 'Verdana', sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} diff --git a/doc/_themes/sphinx13/static/sphinxheader.png b/doc/_themes/sphinx13/static/sphinxheader.png new file mode 100644 index 000000000..2b33f09d9 Binary files /dev/null and b/doc/_themes/sphinx13/static/sphinxheader.png differ diff --git a/doc/_themes/sphinx13/theme.conf b/doc/_themes/sphinx13/theme.conf new file mode 100644 index 000000000..876b19803 --- /dev/null +++ b/doc/_themes/sphinx13/theme.conf @@ -0,0 +1,4 @@ +[theme] +inherit = basic +stylesheet = sphinx13.css +pygments_style = trac diff --git a/doc/conf.py b/doc/conf.py index 1b8ba3e4d..f978f3154 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -18,7 +18,8 @@ version = sphinx.__released__ release = version show_authors = True -html_theme = 'sphinxdoc' +html_theme = 'sphinx13' +html_theme_path = ['_themes'] modindex_common_prefix = ['sphinx.'] html_static_path = ['_static'] html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']} diff --git a/doc/develop.rst b/doc/develop.rst new file mode 100644 index 000000000..4181cde86 --- /dev/null +++ b/doc/develop.rst @@ -0,0 +1,103 @@ +:orphan: + +Sphinx development +================== + +Sphinx is a maintained by a group of volunteers. We value every contribution! + +* The code can be found in a Mercurial repository, at + http://bitbucket.org/birkenfeld/sphinx/. +* Issues and feature requests should be raised in the `tracker + `_. +* The mailing list for development is at `Google Groups + `_. + +For more about our development process and methods, see the :doc:`devguide`. + +Extensions +========== + +The `sphinx-contrib `_ +repository contains many contributed extensions. Some of them have their own +releases on PyPI, others you can install from a checkout. + +This is the current list of contributed extensions in that repository: + +- aafig: render embeded ASCII art as nice images using aafigure_. +- actdiag: embed activity diagrams by using actdiag_ +- adadomain: an extension for Ada support (Sphinx 1.0 needed) +- ansi: parse ANSI color sequences inside documents +- autorun: Execute code in a runblock directive. +- blockdiag: embed block diagrams by using blockdiag_ +- cheeseshop: easily link to PyPI packages +- clearquest: create tables from ClearQuest_ queries. +- coffeedomain: a domain for (auto)documenting CoffeeScript source code. +- context: a builder for ConTeXt. +- doxylink: Link to external Doxygen-generated HTML documentation +- email: obfuscate email addresses +- erlangdomain: an extension for Erlang support (Sphinx 1.0 needed) +- exceltable: embed Excel spreadsheets into documents using exceltable_ +- feed: an extension for creating syndication feeds and time-based overviews + from your site content +- gnuplot: produces images using gnuplot_ language. +- googleanalytics: track html visitors statistics +- googlechart: embed charts by using `Google Chart`_ +- googlemaps: embed maps by using `Google Maps`_ +- httpdomain: a domain for documenting RESTful HTTP APIs. +- hyphenator: client-side hyphenation of HTML using hyphenator_ +- lilypond: an extension inserting music scripts from Lilypond_ in PNG format. +- mscgen: embed mscgen-formatted MSC (Message Sequence Chart)s. +- nicoviceo: embed videos from nicovideo +- nwdiag: embed network diagrams by using nwdiag_ +- omegat: support tools to collaborate with OmegaT_ (Sphinx 1.1 needed) +- osaka: convert standard Japanese doc to Osaka dialect (it is joke extension) +- paverutils: an alternate integration of Sphinx with Paver_. +- phpdomain: an extension for PHP support +- plantuml: embed UML diagram by using PlantUML_ +- rawfiles: copy raw files, like a CNAME. +- requirements: declare requirements wherever you need (e.g. in test + docstrings), mark statuses and collect them in a single list +- rubydomain: an extension for Ruby support (Sphinx 1.0 needed) +- sadisplay: display SqlAlchemy model sadisplay_ +- sdedit: an extension inserting sequence diagram by using Quick Sequence. + Diagram Editor (sdedit_) +- seqdiag: embed sequence diagrams by using seqdiag_ +- slide: embed presentation slides on slideshare_ and other sites. +- swf: embed flash files +- sword: an extension inserting Bible verses from Sword_. +- tikz: draw pictures with the `TikZ/PGF LaTeX package`_. +- traclinks: create TracLinks_ to a Trac_ instance from within Sphinx +- whooshindex: whoosh indexer extension +- youtube: embed videos from YouTube_ +- zopeext: provide an ``autointerface`` directive for using `Zope interfaces`_. + + +See the :ref:`extension tutorial ` on getting started with writing your +own extensions. + + +.. _aafigure: https://launchpad.net/aafigure +.. _gnuplot: http://www.gnuplot.info/ +.. _paver: http://www.blueskyonmars.com/projects/paver/ +.. _Sword: http://www.crosswire.org/sword/ +.. _Lilypond: http://lilypond.org/web/ +.. _sdedit: http://sdedit.sourceforge.net/ +.. _Trac: http://trac.edgewall.org +.. _TracLinks: http://trac.edgewall.org/wiki/TracLinks +.. _OmegaT: http://www.omegat.org/ +.. _PlantUML: http://plantuml.sourceforge.net/ +.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/ +.. _sadisplay: http://bitbucket.org/estin/sadisplay/wiki/Home +.. _blockdiag: http://blockdiag.com/ +.. _seqdiag: http://blockdiag.com/ +.. _actdiag: http://blockdiag.com/ +.. _nwdiag: http://blockdiag.com/ +.. _Google Chart: http://code.google.com/intl/ja/apis/chart/ +.. _Google Maps: http://maps.google.com/ +.. _hyphenator: http://code.google.com/p/hyphenator/ +.. _exceltable: http://packages.python.org/sphinxcontrib-exceltable/ +.. _YouTube: http://www.youtube.com/ +.. _ClearQuest: http://www-01.ibm.com/software/awdtools/clearquest/ +.. _Zope interfaces: http://docs.zope.org/zope.interface/README.html +.. _slideshare: http://www.slideshare.net/ +.. _TikZ/PGF LaTeX package: http://sourceforge.net/projects/pgf/ diff --git a/doc/install.rst b/doc/install.rst new file mode 100644 index 000000000..b39f71674 --- /dev/null +++ b/doc/install.rst @@ -0,0 +1,15 @@ +:orphan: + +Installing Sphinx +================= + +Sphinx is available as a package on the `Python Package Index +`_. + +You can also download a snapshot from the Mercurial development repository: + +* as a `.tar.bz2 `_ + file or +* as a `.zip `_ file + +.. note:: A detailed installation and setup guide is in preparation.