summaryrefslogtreecommitdiff
path: root/Doc/documenting
diff options
context:
space:
mode:
authorChristian Heimes <christian@cheimes.de>2007-12-31 16:14:33 +0000
committerChristian Heimes <christian@cheimes.de>2007-12-31 16:14:33 +0000
commit5b5e81c637eb115b27b4c5c66cf1cf348c706162 (patch)
treee83d0ce68e92750e40fbb901a0659bade6f41674 /Doc/documenting
parent862543aa85249b46649b60da96743b4b14c6c83b (diff)
downloadcpython-git-5b5e81c637eb115b27b4c5c66cf1cf348c706162.tar.gz
Merged revisions 59605-59624 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r59606 | georg.brandl | 2007-12-29 11:57:00 +0100 (Sat, 29 Dec 2007) | 2 lines Some cleanup in the docs. ........ r59611 | martin.v.loewis | 2007-12-29 19:49:21 +0100 (Sat, 29 Dec 2007) | 2 lines Bug #1699: Define _BSD_SOURCE only on OpenBSD. ........ r59612 | raymond.hettinger | 2007-12-29 23:09:34 +0100 (Sat, 29 Dec 2007) | 1 line Simpler documentation for itertools.tee(). Should be backported. ........ r59613 | raymond.hettinger | 2007-12-29 23:16:24 +0100 (Sat, 29 Dec 2007) | 1 line Improve docs for itertools.groupby(). The use of xrange(0) to create a unique object is less obvious than object(). ........ r59620 | christian.heimes | 2007-12-31 15:47:07 +0100 (Mon, 31 Dec 2007) | 3 lines Added wininst-9.0.exe executable for VS 2008 Integrated bdist_wininst into PCBuild9 directory ........ r59621 | christian.heimes | 2007-12-31 15:51:18 +0100 (Mon, 31 Dec 2007) | 1 line Moved PCbuild directory to PC/VS7.1 ........ r59622 | christian.heimes | 2007-12-31 15:59:26 +0100 (Mon, 31 Dec 2007) | 1 line Fix paths for build bot ........ r59623 | christian.heimes | 2007-12-31 16:02:41 +0100 (Mon, 31 Dec 2007) | 1 line Fix paths for build bot, part 2 ........ r59624 | christian.heimes | 2007-12-31 16:18:55 +0100 (Mon, 31 Dec 2007) | 1 line Renamed PCBuild9 directory to PCBuild ........
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 42045f7daf..116524ac55 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 a246d62e9a..f3a82370df 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 85e8b5e326..43da14e192 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