diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/_templates/index.html | 9 | ||||
| -rw-r--r-- | doc/builders.rst | 5 | ||||
| -rw-r--r-- | doc/ext/inheritance.rst | 10 | ||||
| -rw-r--r-- | doc/faq.rst | 5 |
4 files changed, 29 insertions, 0 deletions
diff --git a/doc/_templates/index.html b/doc/_templates/index.html index 1c399f92..0f4d4c64 100644 --- a/doc/_templates/index.html +++ b/doc/_templates/index.html @@ -58,6 +58,7 @@ </p> <h2>Documentation</h2> + <table class="contentstable" align="center" style="margin-left: 30px"><tr> <td width="50%"> <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Contents</a><br/> @@ -72,6 +73,14 @@ </td></tr> </table> + <p>You may also be interested in the very nice + <a href="http://matplotlib.sourceforge.net/sampledoc/">tutorial</a> on how to + create a customized documentation using Sphinx written by the matplotlib + developers.</p> + + <p>There is a <a href="http://sphinx.shibu.jp/">Japanese translation</a> + of this documentation, thanks to Yoshiki Shibukawa.</p> + <h2>Get Sphinx</h2> <p> Sphinx is available as an <a diff --git a/doc/builders.rst b/doc/builders.rst index 7891ce74..7c1f03d3 100644 --- a/doc/builders.rst +++ b/doc/builders.rst @@ -84,6 +84,11 @@ The builder's "name" must be given to the **-b** command-line option of Its name is ``latex``. +Note that a direct PDF builder using ReportLab is available in `rst2pdf +<http://rst2pdf.googlecode.com>`_ version 0.12 or greater. You need to add +``'rst2pdf.pdfbuilder'`` to your :confval:`extensions` to enable it, its name is +``pdf``. + .. module:: sphinx.builders.text .. class:: TextBuilder diff --git a/doc/ext/inheritance.rst b/doc/ext/inheritance.rst index fe6d636d..72849e05 100644 --- a/doc/ext/inheritance.rst +++ b/doc/ext/inheritance.rst @@ -37,10 +37,20 @@ New config values are: A dictionary of graphviz graph attributes for inheritance diagrams. + For example:: + + inheritance_graph_attrs = dict(rankdir="LR", size='"6.0, 8.0"', + fontsize=14, ratio='compress') + .. confval:: inheritance_node_attrs A dictionary of graphviz node attributes for inheritance diagrams. + For example:: + + inheritance_node_attrs = dict(shape='ellipse', fontsize=14, height=0.75, + color='dodgerblue1', style='filled') + .. confval:: inheritance_edge_attrs A dictionary of graphviz edge attributes for inheritance diagrams. diff --git a/doc/faq.rst b/doc/faq.rst index a26ae930..d429ba6f 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -9,6 +9,11 @@ suggest new entries! How do I... ----------- +... create PDF files without LaTeX? + You can use `rst2pdf <http://rst2pdf.googlecode.com>`_ version 0.12 or greater + which comes with built-in Sphinx integration. See the :ref:`builders` + section for details. + ... get section numbers? They are automatic in LaTeX output; for HTML, give a ``:numbered:`` option to the :dir:`toctree` directive where you want to start numbering. |