IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

merge with 0.6

Browse Source
This commit is contained in:
Georg Brandl 2009-05-16 12:49:58 +02:00
commit 95dbaa5360
3 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/faq.rst
View File

@ -22,19 +22,32 @@ How do I...
... write my own extension? ... write my own extension?
See the :ref:`extension tutorial <exttut>`. See the :ref:`extension tutorial <exttut>`.
... use Sphinx with Epydoc?
There's a third-party extension providing an `api role`_ which refers to
Epydoc's API docs for a given identifier.
... use Sphinx with SCons?
Glenn Hutchings has written a SCons build script to build Sphinx
documentation; it is hosted here: http://bitbucket.org/zondo/sphinx-scons
... convert from my existing docs using MoinMoin markup? ... convert from my existing docs using MoinMoin markup?
The easiest way is to convert to xhtml, then convert `xhtml to reST`_. You'll The easiest way is to convert to xhtml, then convert `xhtml to reST`_. You'll
still need to mark up classes and such, but the headings and code examples still need to mark up classes and such, but the headings and code examples
come through cleanly. come through cleanly.
Using Sphinx with...
--------------------
Epydoc
There's a third-party extension providing an `api role`_ which refers to
Epydoc's API docs for a given identifier.
Doxygen
Michael Jones is developing a reST/Sphinx bridge to doxygen called `breathe
<http://github.com/michaeljones/breathe/tree/master>`_.
SCons
Glenn Hutchings has written a SCons build script to build Sphinx
documentation; it is hosted here: http://bitbucket.org/zondo/sphinx-scons
github pages
You can use `Michael Jones' sphinx-to-github tool
<http://github.com/michaeljones/sphinx-to-github/tree/master>`_ to prepare
Sphinx HTML output.
.. _api role: http://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py .. _api role: http://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py
.. _xhtml to reST: http://docutils.sourceforge.net/sandbox/xhtml2rest/xhtml2rest.py .. _xhtml to reST: http://docutils.sourceforge.net/sandbox/xhtml2rest/xhtml2rest.py

2
sphinx/builders/html.py
View File

@ -585,7 +585,7 @@ class StandaloneHTMLBuilder(Builder):
def post_process_images(self, doctree): def post_process_images(self, doctree):
""" """
Pick the best candiate for an image and link down-scaled images to Pick the best candidate for an image and link down-scaled images to
their high res version. their high res version.
""" """
Builder.post_process_images(self, doctree) Builder.post_process_images(self, doctree)

2
sphinx/environment.py
View File

@ -710,7 +710,7 @@ class BuildEnvironment:
for node in doctree.traverse(nodes.image): for node in doctree.traverse(nodes.image):
# Map the mimetype to the corresponding image. The writer may # Map the mimetype to the corresponding image. The writer may
# choose the best image from these candidates. The special key * is # choose the best image from these candidates. The special key * is
# set if there is only single candiate to be used by a writer. # set if there is only single candidate to be used by a writer.
# The special key ? is set for nonlocal URIs. # The special key ? is set for nonlocal URIs.
node['candidates'] = candidates = {} node['candidates'] = candidates = {}
imguri = node['uri'] imguri = node['uri']