summaryrefslogtreecommitdiffstats
path: root/Doc/documenting
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
parent28c7bcf38e1e69a9091cbba90b982331428ddbe6 (diff)
downloadcpython-b19be571e09263239ef29c92eee06dbb30186685.zip
cpython-b19be571e09263239ef29c92eee06dbb30186685.tar.gz
cpython-b19be571e09263239ef29c92eee06dbb30186685.tar.bz2
Some cleanup in the docs.
Diffstat (limited to 'Doc/documenting')
-rw-r--r--Doc/documenting/fromlatex.rst30
-rw-r--r--Doc/documenting/markup.rst2
-rw-r--r--Doc/documenting/sphinx.rst26
3 files changed, 42 insertions, 16 deletions
diff --git a/Doc/documenting/fromlatex.rst b/Doc/documenting/fromlatex.rst
index 42045f7..116524a 100644
--- a/Doc/documenting/fromlatex.rst
+++ b/Doc/documenting/fromlatex.rst
@@ -154,25 +154,35 @@ These changes to information units should be noted:
Description.
-* **New information unit**
+* **New information units**
- There is a new generic information unit called "describe" which can be used
- to document things that are not covered by the other units::
+ There are new generic information units: One is called "describe" and can be
+ used to document things that are not covered by the other units::
.. describe:: a == b
The equals operator.
+ The others are::
+
+ .. cmdoption:: -O
+
+ Describes a command-line option.
+
+ .. envvar:: PYTHONINSPECT
+
+ Describes an environment variable.
+
Structure
---------
-The LaTeX docs were split in several toplevel manuals. Now, all files
-are part of the same documentation tree, as indicated by the *toctree*
-directives in the sources. Every *toctree* directive embeds other files
-as subdocuments of the current file (this structure is not necessarily
-mirrored in the filesystem layout). The toplevel file is
-:file:`contents.rst`.
+The LaTeX docs were split in several toplevel manuals. Now, all files are part
+of the same documentation tree, as indicated by the *toctree* directives in the
+sources (though individual output formats may choose to split them up into parts
+again). Every *toctree* directive embeds other files as subdocuments of the
+current file (this structure is not necessarily mirrored in the filesystem
+layout). The toplevel file is :file:`contents.rst`.
However, most of the old directory structure has been kept, with the
directories renamed as follows:
@@ -184,7 +194,7 @@ directories renamed as follows:
* :file:`inst` -> :file:`installing`
* :file:`lib` -> :file:`library`
* :file:`mac` -> merged into :file:`library`, with :file:`mac/using.tex`
- moved to :file:`howto/pythonmac.rst`
+ moved to :file:`using/mac.rst`
* :file:`ref` -> :file:`reference`
* :file:`tut` -> :file:`tutorial`, with the single TeX file split up
diff --git a/Doc/documenting/markup.rst b/Doc/documenting/markup.rst
index a246d62..f3a8237 100644
--- a/Doc/documenting/markup.rst
+++ b/Doc/documenting/markup.rst
@@ -455,7 +455,7 @@ in a different style:
.. describe:: keyword
- The name of a keyword in a programming language.
+ The name of a keyword in Python.
.. describe:: mailheader
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