summaryrefslogtreecommitdiffstats
path: root/Doc/documenting/sphinx.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-12-29 10:57:00 (GMT)
committerGeorg Brandl <georg@python.org>2007-12-29 10:57:00 (GMT)
commitb19be571e09263239ef29c92eee06dbb30186685 (patch)
tree9c8a5439b14ce34cfaa0e4e164483b0f8690aa42 /Doc/documenting/sphinx.rst
parent28c7bcf38e1e69a9091cbba90b982331428ddbe6 (diff)
downloadcpython-b19be571e09263239ef29c92eee06dbb30186685.zip
cpython-b19be571e09263239ef29c92eee06dbb30186685.tar.gz
cpython-b19be571e09263239ef29c92eee06dbb30186685.tar.bz2
Some cleanup in the docs.
Diffstat (limited to 'Doc/documenting/sphinx.rst')
-rw-r--r--Doc/documenting/sphinx.rst26
1 files changed, 21 insertions, 5 deletions
diff --git a/Doc/documenting/sphinx.rst b/Doc/documenting/sphinx.rst
index 85e8b5e..43da14e 100644
--- a/Doc/documenting/sphinx.rst
+++ b/Doc/documenting/sphinx.rst
@@ -47,14 +47,30 @@ unused_files : list of strings
could be docs for temporarily disabled modules or documentation that's not
yet ready for public consumption.
-last_updated_format : string
+add_function_parentheses : bool
+ If true, ``()`` will be appended to the content of ``:func:``, ``:meth:`` and
+ ``:cfunc:`` cross-references.
+
+add_module_names : bool
+ If true, the current module name will be prepended to all description unit
+ titles (such as ``.. function::``).
+
+Builder-specific variables
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+html_download_base_url : string
+ The base URL for download links on the download page.
+
+html_last_updated_fmt : string
If this is not an empty string, it will be given to ``time.strftime()`` and
written to each generated output file after "last updated on:".
-use_smartypants : bool
+html_use_smartypants : bool
If true, use SmartyPants to convert quotes and dashes to the typographically
correct entities.
-add_function_parentheses : bool
- If true, ``()`` will be appended to the content of ``:func:``, ``:meth:`` and
- ``:cfunc:`` cross-references. \ No newline at end of file
+latex_paper_size : "letter" or "a4"
+ The paper size option for the LaTeX document class.
+
+latex_font_size : "10pt", "11pt" or "12pt"
+ The font size option for the LaTeX document class. \ No newline at end of file