From 92f420bd22f9cc91a877f4fc6f8bca73e583bdd7 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Wed, 13 May 2009 09:15:29 +0200 Subject: [PATCH 1/2] Add more interop links. --- doc/faq.rst | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/doc/faq.rst b/doc/faq.rst index 10a6f2c48..a724ddcaf 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -22,19 +22,32 @@ How do I... ... write my own extension? See the :ref:`extension tutorial `. -... 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? 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 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 + `_. + +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 + `_ to prepare + Sphinx HTML output. + + .. _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 From adfb8c26683bd010392437e479869029ae49c1cb Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sat, 16 May 2009 12:47:18 +0200 Subject: [PATCH 2/2] Fix speling. --- sphinx/builders/html.py | 2 +- sphinx/environment.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index a1731b3a9..b7c63fc09 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -570,7 +570,7 @@ class StandaloneHTMLBuilder(Builder): 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. """ Builder.post_process_images(self, doctree) diff --git a/sphinx/environment.py b/sphinx/environment.py index 064b71ae1..1229656a9 100644 --- a/sphinx/environment.py +++ b/sphinx/environment.py @@ -710,7 +710,7 @@ class BuildEnvironment: for node in doctree.traverse(nodes.image): # Map the mimetype to the corresponding image. The writer may # 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. node['candidates'] = candidates = {} imguri = node['uri']