From d769d4ae71ce8b8c98c7b77f7a8e7cf4a9666f4d Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 08:47:20 +0100 Subject: [PATCH 01/13] Change sphinx-dev to sphinx-users where applicable. --- EXAMPLES | 2 +- doc/_templates/indexsidebar.html | 4 ++-- sphinx/cmdline.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/EXAMPLES b/EXAMPLES index bb5712d49..9b4af650a 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -4,7 +4,7 @@ Projects using Sphinx This is an (incomplete) alphabetic list of projects that use Sphinx or are experimenting with using it for their documentation. If you like to be included, please mail to `the Google group -`_. +`_. I've grouped the list into sections to make it easier to find interesting examples. diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html index feafd9046..a8129f019 100644 --- a/doc/_templates/indexsidebar.html +++ b/doc/_templates/indexsidebar.html @@ -20,8 +20,8 @@ are also available.

Questions? Suggestions?

-

Join the Google group:

-
Join the Google group:

+ diff --git a/sphinx/cmdline.py b/sphinx/cmdline.py index 9fc213716..eff89b944 100644 --- a/sphinx/cmdline.py +++ b/sphinx/cmdline.py @@ -223,7 +223,7 @@ def main(argv): 'can be provided next time.') print >>error, ( 'Either send bugs to the mailing list at ' - ',\n' + ',\n' 'or report them in the tracker at ' '. Thanks!') return 1 From ede91a36d0d5f03807477985b52a4decf3f92202 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 08:53:41 +0100 Subject: [PATCH 02/13] Add or-tools. --- EXAMPLES | 1 + 1 file changed, 1 insertion(+) diff --git a/EXAMPLES b/EXAMPLES index 9b4af650a..039a1f8f9 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -70,6 +70,7 @@ Documentation using a customized version of the default theme * Chaco: http://code.enthought.com/projects/chaco/docs/html/ * Djagios: http://djagios.org/ * GetFEM++: http://home.gna.org/getfem/ +* Google or-tools: https://or-tools.googlecode.com/svn/trunk/documentation/user_manual/index.html * GPAW: https://wiki.fysik.dtu.dk/gpaw/ * Grok: http://grok.zope.org/doc/current/ * IFM: http://fluffybunny.memebot.com/ifm-docs/index.html From 2671d5543681871f11bbf7b6223e142850810dd7 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 09:55:44 +0100 Subject: [PATCH 03/13] Update required Python to 2.5. --- setup.py | 20 ++------------------ tox.ini | 12 ++++++------ 2 files changed, 8 insertions(+), 24 deletions(-) diff --git a/setup.py b/setup.py index ca41aa431..720dc77b9 100644 --- a/setup.py +++ b/setup.py @@ -46,25 +46,9 @@ A development egg can be found `here requires = ['Pygments>=1.2', 'Jinja2>=2.3', 'docutils>=0.7'] -if sys.version_info < (2, 4): - print('ERROR: Sphinx requires at least Python 2.4 to run.') - sys.exit(1) - if sys.version_info < (2, 5): - # Python 2.4's distutils doesn't automatically install an egg-info, - # so an existing docutils install won't be detected -- in that case, - # remove the dependency from setup.py - try: - import docutils - if int(docutils.__version__[2]) < 4: - raise ValueError('docutils not recent enough') - except: - pass - else: - del requires[-1] - - # The uuid module is new in the stdlib in 2.5 - requires.append('uuid>=1.30') + print('ERROR: Sphinx requires at least Python 2.5 to run.') + sys.exit(1) # Provide a "compile_catalog" command that also creates the translated diff --git a/tox.ini b/tox.ini index ef61bdef2..bfb50e398 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist=py24,py25,py26,py27,py31,py32,pypy,du08,du07,du06,du05 +envlist=py25,py26,py27,py31,py32,pypy,du09,du08,du07 [testenv] deps= @@ -10,11 +10,6 @@ commands= {envpython} tests/run.py {posargs} sphinx-build -W -b html -d {envtmpdir}/doctrees doc {envtmpdir}/html -[testenv:py24] -deps= - nose - simplejson==2.1.0 - [testenv:py25] deps= nose @@ -44,3 +39,8 @@ deps= deps= nose docutils==0.8.1 + +[testenv:du09] +deps= + nose + docutils==0.9.1 From cac6b441692372bdb51f7676f835f6df4e2f0706 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:11:05 +0100 Subject: [PATCH 04/13] Add MathJax. --- EXAMPLES | 1 + 1 file changed, 1 insertion(+) diff --git a/EXAMPLES b/EXAMPLES index 039a1f8f9..1dbdf20b0 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -144,6 +144,7 @@ Documentation using a custom theme/integrated in a site * Gameduino: http://excamera.com/sphinx/gameduino/ * GeoServer: http://docs.geoserver.org/ * Glashammer: http://glashammer.org/ +* MathJax: http://docs.mathjax.org/en/latest/ * MirrorBrain: http://mirrorbrain.org/docs/ * nose: http://somethingaboutorange.com/mrl/projects/nose/ * ObjectListView: http://objectlistview.sourceforge.net/python From 9a2760fcb1d5263a82992e3bf05857e3dca96e13 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:18:11 +0100 Subject: [PATCH 05/13] Add DEAP. --- EXAMPLES | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/EXAMPLES b/EXAMPLES index 1dbdf20b0..d80bb592d 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -136,7 +136,8 @@ Documentation using a custom theme/integrated in a site * Blender: http://www.blender.org/documentation/250PythonDoc/ * Blinker: http://discorporate.us/projects/Blinker/docs/ -* Classy: classy: http://classy.pocoo.org/ +* Classy: http://classy.pocoo.org/ +* DEAP: http://deap.gel.ulaval.ca/doc/0.8/index.html * Django: http://docs.djangoproject.com/ * e-cidadania: http://e-cidadania.readthedocs.org/en/latest/ * Flask: http://flask.pocoo.org/docs/ From 1d4c1c11f5da65a7d1d17f890839100f07a42874 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:19:41 +0100 Subject: [PATCH 06/13] Add PSI4. --- EXAMPLES | 1 + 1 file changed, 1 insertion(+) diff --git a/EXAMPLES b/EXAMPLES index d80bb592d..3c46d77cf 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -153,6 +153,7 @@ Documentation using a custom theme/integrated in a site * OpenLayers: http://docs.openlayers.org/ * PyEphem: http://rhodesmill.org/pyephem/ * German Plone 4.0 user manual: http://www.hasecke.com/plone-benutzerhandbuch/4.0/ +* PSI4: http://sirius.chem.vt.edu/psi4manual/latest/index.html * Pylons: http://pylonshq.com/docs/en/0.9.7/ * PyMOTW: http://www.doughellmann.com/PyMOTW/ * pypol: http://pypol.altervista.org/ (celery) From b40a5a0c0e17ebd4444b520c6306806f85737a16 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:20:10 +0100 Subject: [PATCH 07/13] Add Turbulenz. --- EXAMPLES | 1 + 1 file changed, 1 insertion(+) diff --git a/EXAMPLES b/EXAMPLES index 3c46d77cf..555559b52 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -110,6 +110,7 @@ Documentation using the sphinxdoc theme * Sqlkit: http://sqlkit.argolinux.org/ * Tau: http://www.tango-controls.org/static/tau/latest/doc/html/index.html * Total Open Station: http://tops.berlios.de/ +* Turbulenz: http://docs.turbulenz.com/ * WebFaction: http://docs.webfaction.com/ From 6f824a533d6962180a453ac52f77f95c074114c6 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:20:59 +0100 Subject: [PATCH 08/13] Add Valence. --- EXAMPLES | 1 + 1 file changed, 1 insertion(+) diff --git a/EXAMPLES b/EXAMPLES index 555559b52..f946fd502 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -130,6 +130,7 @@ Documentation using another builtin theme (agogo) * Sylli: http://sylli.sourceforge.net/ (nature) * libLAS: http://liblas.org/ (nature) +* Valence: http://docs.valence.desire2learn.com/ (haiku) Documentation using a custom theme/integrated in a site From 447ba07b3c78285d9339f3b533d42a2914e0ed6f Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:21:53 +0100 Subject: [PATCH 09/13] Add Istihza. --- EXAMPLES | 1 + 1 file changed, 1 insertion(+) diff --git a/EXAMPLES b/EXAMPLES index f946fd502..d012b986c 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -147,6 +147,7 @@ Documentation using a custom theme/integrated in a site * Gameduino: http://excamera.com/sphinx/gameduino/ * GeoServer: http://docs.geoserver.org/ * Glashammer: http://glashammer.org/ +* Istihza (Turkish Python documentation project): http://www.istihza.com/py2/icindekiler_python.html * MathJax: http://docs.mathjax.org/en/latest/ * MirrorBrain: http://mirrorbrain.org/docs/ * nose: http://somethingaboutorange.com/mrl/projects/nose/ From 4961799528d1eec183cf6b77e669c3009e50d78a Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:22:51 +0100 Subject: [PATCH 10/13] Remove obsolete tox environments. --- tox.ini | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/tox.ini b/tox.ini index bfb50e398..d6769a2a0 100644 --- a/tox.ini +++ b/tox.ini @@ -20,16 +20,6 @@ deps= nose simplejson -[testenv:du05] -deps= - nose - docutils==0.5 - -[testenv:du06] -deps= - nose - docutils==0.6 - [testenv:du07] deps= nose From d13c0470afb6674c754817d23c5cc61a170a6989 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:24:57 +0100 Subject: [PATCH 11/13] Update requirements documentation. --- doc/intro.rst | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/doc/intro.rst b/doc/intro.rst index 5d76dd29c..4d052c818 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -50,19 +50,15 @@ See the :ref:`pertinent section in the FAQ list `. Prerequisites ------------- -Sphinx needs at least **Python 2.4** or **Python 3.1** to run, as well as the +Sphinx needs at least **Python 2.5** or **Python 3.1** to run, as well as the docutils_ and Jinja2_ libraries. Sphinx should work with docutils version 0.7 or some (not broken) SVN trunk snapshot. If you like to have source code highlighting support, you must also install the Pygments_ library. -If you use **Python 2.4** you also need uuid_. - .. _reStructuredText: http://docutils.sf.net/rst.html .. _docutils: http://docutils.sf.net/ .. _Jinja2: http://jinja.pocoo.org/ .. _Pygments: http://pygments.org/ -.. The given homepage is only a directory listing so I'm using the pypi site. -.. _uuid: http://pypi.python.org/pypi/uuid/ Usage From f4cfc4531931a845b093823d12a7eefe00b2dc45 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:46:32 +0100 Subject: [PATCH 12/13] Add a py33 environment. --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index d6769a2a0..d0ea6ed8d 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist=py25,py26,py27,py31,py32,pypy,du09,du08,du07 +envlist=py25,py26,py27,py31,py32,py33,pypy,du09,du08,du07 [testenv] deps= From c411b51fbbdaae201331123c5a449ea7f5f8b0c8 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Tue, 30 Oct 2012 10:48:48 +0100 Subject: [PATCH 13/13] Closes #998: fix manpage writer in expectation of docutils 0.10 API change --- sphinx/writers/manpage.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/sphinx/writers/manpage.py b/sphinx/writers/manpage.py index 81f2988b2..e074691e4 100644 --- a/sphinx/writers/manpage.py +++ b/sphinx/writers/manpage.py @@ -72,6 +72,11 @@ class ManualPageTranslator(BaseTranslator): # since self.append_header() is never called, need to do this here self.body.append(MACRO_DEF) + # Overwrite admonition label translations with our own + for label, translation in admonitionlabels.items(): + self.language.labels[label] = self.deunicode(translation) + + # overwritten -- added quotes around all .TH arguments def header(self): tmpl = (".TH \"%(title_upper)s\" \"%(manual_section)s\"" @@ -193,12 +198,6 @@ class ManualPageTranslator(BaseTranslator): def depart_seealso(self, node): self.depart_admonition(node) - # overwritten -- use our own label translations - def visit_admonition(self, node, name=None): - if name: - self.body.append('.IP %s\n' % - self.deunicode(admonitionlabels.get(name, name))) - def visit_productionlist(self, node): self.ensure_eol() names = []