mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
merge heads
This commit is contained in:
commit
d51b5d5118
11
EXAMPLES
11
EXAMPLES
@ -4,7 +4,7 @@ Projects using Sphinx
|
|||||||
This is an (incomplete) alphabetic list of projects that use Sphinx or
|
This is an (incomplete) alphabetic list of projects that use Sphinx or
|
||||||
are experimenting with using it for their documentation. If you like to
|
are experimenting with using it for their documentation. If you like to
|
||||||
be included, please mail to `the Google group
|
be included, please mail to `the Google group
|
||||||
<http://groups.google.com/group/sphinx-dev>`_.
|
<http://groups.google.com/group/sphinx-users>`_.
|
||||||
|
|
||||||
I've grouped the list into sections to make it easier to find
|
I've grouped the list into sections to make it easier to find
|
||||||
interesting examples.
|
interesting examples.
|
||||||
@ -70,6 +70,7 @@ Documentation using a customized version of the default theme
|
|||||||
* Chaco: http://code.enthought.com/projects/chaco/docs/html/
|
* Chaco: http://code.enthought.com/projects/chaco/docs/html/
|
||||||
* Djagios: http://djagios.org/
|
* Djagios: http://djagios.org/
|
||||||
* GetFEM++: http://home.gna.org/getfem/
|
* 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/
|
* GPAW: https://wiki.fysik.dtu.dk/gpaw/
|
||||||
* Grok: http://grok.zope.org/doc/current/
|
* Grok: http://grok.zope.org/doc/current/
|
||||||
* IFM: http://fluffybunny.memebot.com/ifm-docs/index.html
|
* IFM: http://fluffybunny.memebot.com/ifm-docs/index.html
|
||||||
@ -109,6 +110,7 @@ Documentation using the sphinxdoc theme
|
|||||||
* Sqlkit: http://sqlkit.argolinux.org/
|
* Sqlkit: http://sqlkit.argolinux.org/
|
||||||
* Tau: http://www.tango-controls.org/static/tau/latest/doc/html/index.html
|
* Tau: http://www.tango-controls.org/static/tau/latest/doc/html/index.html
|
||||||
* Total Open Station: http://tops.berlios.de/
|
* Total Open Station: http://tops.berlios.de/
|
||||||
|
* Turbulenz: http://docs.turbulenz.com/
|
||||||
* WebFaction: http://docs.webfaction.com/
|
* WebFaction: http://docs.webfaction.com/
|
||||||
|
|
||||||
|
|
||||||
@ -128,6 +130,7 @@ Documentation using another builtin theme
|
|||||||
(agogo)
|
(agogo)
|
||||||
* Sylli: http://sylli.sourceforge.net/ (nature)
|
* Sylli: http://sylli.sourceforge.net/ (nature)
|
||||||
* libLAS: http://liblas.org/ (nature)
|
* libLAS: http://liblas.org/ (nature)
|
||||||
|
* Valence: http://docs.valence.desire2learn.com/ (haiku)
|
||||||
|
|
||||||
|
|
||||||
Documentation using a custom theme/integrated in a site
|
Documentation using a custom theme/integrated in a site
|
||||||
@ -135,7 +138,8 @@ Documentation using a custom theme/integrated in a site
|
|||||||
|
|
||||||
* Blender: http://www.blender.org/documentation/250PythonDoc/
|
* Blender: http://www.blender.org/documentation/250PythonDoc/
|
||||||
* Blinker: http://discorporate.us/projects/Blinker/docs/
|
* 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/
|
* Django: http://docs.djangoproject.com/
|
||||||
* e-cidadania: http://e-cidadania.readthedocs.org/en/latest/
|
* e-cidadania: http://e-cidadania.readthedocs.org/en/latest/
|
||||||
* Flask: http://flask.pocoo.org/docs/
|
* Flask: http://flask.pocoo.org/docs/
|
||||||
@ -143,6 +147,8 @@ Documentation using a custom theme/integrated in a site
|
|||||||
* Gameduino: http://excamera.com/sphinx/gameduino/
|
* Gameduino: http://excamera.com/sphinx/gameduino/
|
||||||
* GeoServer: http://docs.geoserver.org/
|
* GeoServer: http://docs.geoserver.org/
|
||||||
* Glashammer: http://glashammer.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/
|
* MirrorBrain: http://mirrorbrain.org/docs/
|
||||||
* nose: http://somethingaboutorange.com/mrl/projects/nose/
|
* nose: http://somethingaboutorange.com/mrl/projects/nose/
|
||||||
* ObjectListView: http://objectlistview.sourceforge.net/python
|
* ObjectListView: http://objectlistview.sourceforge.net/python
|
||||||
@ -150,6 +156,7 @@ Documentation using a custom theme/integrated in a site
|
|||||||
* OpenLayers: http://docs.openlayers.org/
|
* OpenLayers: http://docs.openlayers.org/
|
||||||
* PyEphem: http://rhodesmill.org/pyephem/
|
* PyEphem: http://rhodesmill.org/pyephem/
|
||||||
* German Plone 4.0 user manual: http://www.hasecke.com/plone-benutzerhandbuch/4.0/
|
* 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/
|
* Pylons: http://pylonshq.com/docs/en/0.9.7/
|
||||||
* PyMOTW: http://www.doughellmann.com/PyMOTW/
|
* PyMOTW: http://www.doughellmann.com/PyMOTW/
|
||||||
* pypol: http://pypol.altervista.org/ (celery)
|
* pypol: http://pypol.altervista.org/ (celery)
|
||||||
|
4
doc/_templates/indexsidebar.html
vendored
4
doc/_templates/indexsidebar.html
vendored
@ -20,8 +20,8 @@ are also available.</p>
|
|||||||
|
|
||||||
<h3>Questions? Suggestions?</h3>
|
<h3>Questions? Suggestions?</h3>
|
||||||
|
|
||||||
<p>Join the <a href="http://groups.google.com/group/sphinx-dev">Google group</a>:</p>
|
<p>Join the <a href="http://groups.google.com/group/sphinx-users">Google group</a>:</p>
|
||||||
<form action="http://groups.google.com/group/sphinx-dev/boxsubscribe"
|
<form action="http://groups.google.com/group/sphinx-users/boxsubscribe"
|
||||||
style="padding-left: 1em">
|
style="padding-left: 1em">
|
||||||
<input type="text" name="email" value="your@email"/>
|
<input type="text" name="email" value="your@email"/>
|
||||||
<input type="submit" name="sub" value="Subscribe" />
|
<input type="submit" name="sub" value="Subscribe" />
|
||||||
|
@ -50,19 +50,15 @@ See the :ref:`pertinent section in the FAQ list <usingwith>`.
|
|||||||
Prerequisites
|
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
|
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
|
or some (not broken) SVN trunk snapshot. If you like to have source code
|
||||||
highlighting support, you must also install the Pygments_ library.
|
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
|
.. _reStructuredText: http://docutils.sf.net/rst.html
|
||||||
.. _docutils: http://docutils.sf.net/
|
.. _docutils: http://docutils.sf.net/
|
||||||
.. _Jinja2: http://jinja.pocoo.org/
|
.. _Jinja2: http://jinja.pocoo.org/
|
||||||
.. _Pygments: http://pygments.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
|
Usage
|
||||||
|
20
setup.py
20
setup.py
@ -46,25 +46,9 @@ A development egg can be found `here
|
|||||||
|
|
||||||
requires = ['Pygments>=1.2', 'Jinja2>=2.3', 'docutils>=0.7']
|
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):
|
if sys.version_info < (2, 5):
|
||||||
# Python 2.4's distutils doesn't automatically install an egg-info,
|
print('ERROR: Sphinx requires at least Python 2.5 to run.')
|
||||||
# so an existing docutils install won't be detected -- in that case,
|
sys.exit(1)
|
||||||
# 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')
|
|
||||||
|
|
||||||
|
|
||||||
# Provide a "compile_catalog" command that also creates the translated
|
# Provide a "compile_catalog" command that also creates the translated
|
||||||
|
@ -223,7 +223,7 @@ def main(argv):
|
|||||||
'can be provided next time.')
|
'can be provided next time.')
|
||||||
print >>error, (
|
print >>error, (
|
||||||
'Either send bugs to the mailing list at '
|
'Either send bugs to the mailing list at '
|
||||||
'<http://groups.google.com/group/sphinx-dev/>,\n'
|
'<http://groups.google.com/group/sphinx-users/>,\n'
|
||||||
'or report them in the tracker at '
|
'or report them in the tracker at '
|
||||||
'<http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!')
|
'<http://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!')
|
||||||
return 1
|
return 1
|
||||||
|
@ -72,6 +72,11 @@ class ManualPageTranslator(BaseTranslator):
|
|||||||
# since self.append_header() is never called, need to do this here
|
# since self.append_header() is never called, need to do this here
|
||||||
self.body.append(MACRO_DEF)
|
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
|
# overwritten -- added quotes around all .TH arguments
|
||||||
def header(self):
|
def header(self):
|
||||||
tmpl = (".TH \"%(title_upper)s\" \"%(manual_section)s\""
|
tmpl = (".TH \"%(title_upper)s\" \"%(manual_section)s\""
|
||||||
@ -193,12 +198,6 @@ class ManualPageTranslator(BaseTranslator):
|
|||||||
def depart_seealso(self, node):
|
def depart_seealso(self, node):
|
||||||
self.depart_admonition(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):
|
def visit_productionlist(self, node):
|
||||||
self.ensure_eol()
|
self.ensure_eol()
|
||||||
names = []
|
names = []
|
||||||
|
25
tox.ini
25
tox.ini
@ -1,5 +1,5 @@
|
|||||||
[tox]
|
[tox]
|
||||||
envlist=py24,py25,py26,py27,py31,py32,pypy,du08,du07,du06,du05
|
envlist=py25,py26,py27,py31,py32,py33,pypy,du09,du08,du07
|
||||||
|
|
||||||
[testenv]
|
[testenv]
|
||||||
deps=
|
deps=
|
||||||
@ -10,14 +10,6 @@ commands=
|
|||||||
{envpython} tests/run.py {posargs}
|
{envpython} tests/run.py {posargs}
|
||||||
sphinx-build -W -b html -d {envtmpdir}/doctrees doc {envtmpdir}/html
|
sphinx-build -W -b html -d {envtmpdir}/doctrees doc {envtmpdir}/html
|
||||||
|
|
||||||
[testenv:py24]
|
|
||||||
; simplejson 2.1.0 is last version that have compatibility to Python2.4.
|
|
||||||
; Pygments 1.5 have incompatibility to Python2.4
|
|
||||||
deps=
|
|
||||||
nose
|
|
||||||
simplejson==2.1.0
|
|
||||||
Pygments==1.4
|
|
||||||
|
|
||||||
[testenv:py25]
|
[testenv:py25]
|
||||||
deps=
|
deps=
|
||||||
nose
|
nose
|
||||||
@ -28,16 +20,6 @@ deps=
|
|||||||
nose
|
nose
|
||||||
simplejson
|
simplejson
|
||||||
|
|
||||||
[testenv:du05]
|
|
||||||
deps=
|
|
||||||
nose
|
|
||||||
docutils==0.5
|
|
||||||
|
|
||||||
[testenv:du06]
|
|
||||||
deps=
|
|
||||||
nose
|
|
||||||
docutils==0.6
|
|
||||||
|
|
||||||
[testenv:du07]
|
[testenv:du07]
|
||||||
deps=
|
deps=
|
||||||
nose
|
nose
|
||||||
@ -47,3 +29,8 @@ deps=
|
|||||||
deps=
|
deps=
|
||||||
nose
|
nose
|
||||||
docutils==0.8.1
|
docutils==0.8.1
|
||||||
|
|
||||||
|
[testenv:du09]
|
||||||
|
deps=
|
||||||
|
nose
|
||||||
|
docutils==0.9.1
|
||||||
|
Loading…
Reference in New Issue
Block a user