[Epydoc-commits] SF.net SVN: epydoc: [1554] trunk/epydoc
Brought to you by:
edloper
Menu
▾
▴
[Epydoc-commits] SF.net SVN: epydoc: [1554] trunk/epydoc
|
From: <ed...@us...> - 2007-02-27 03:31:58
|
Revision: 1554
http://svn.sourceforge.net/epydoc/?rev=1554&view=rev
Author: edloper
Date: 2007-02-26 19:31:56 -0800 (Mon, 26 Feb 2007)
Log Message:
-----------
- Various formatting & css changes for the manual
- Added navbar to the bottom of generated manual html pages
Modified Paths:
--------------
trunk/epydoc/Makefile
trunk/epydoc/doc/custom.css
trunk/epydoc/doc/manual-fields.txt
trunk/epydoc/doc/manual-usage.txt
trunk/epydoc/doc/manual.txt
Added Paths:
-----------
trunk/epydoc/doc/rst-template.txt
trunk/epydoc/doc/rst-template2.txt
Modified: trunk/epydoc/Makefile
===================================================================
--- trunk/epydoc/Makefile 2007-02-27 00:07:56 UTC (rev 1553)
+++ trunk/epydoc/Makefile 2007-02-27 03:31:56 UTC (rev 1554)
@@ -111,14 +111,13 @@
manual-html: $(MANUAL_HTML_FILES)
$(HTML_MANUAL)/epydoc.html: doc/manual.txt $(MANUAL_SRC)
- $(RST2HTML) doc/manual.txt $@
+ $(RST2HTML) doc/manual.txt $@ --template=doc/rst-template.txt
$(HTML_MANUAL)/manual-%.html: doc/manual-%.txt
- echo .. contents:: > doc/tmp.txt
- echo .. include:: ../$< >> doc/tmp.txt
+ echo ".. include:: ../$<" > doc/tmp.txt
$(MKDISPATCH) $(MANUAL_SRC) >> doc/tmp.txt
- $(RST2HTML) doc/tmp.txt $@
-
+ $(RST2HTML) doc/tmp.txt $@ --template=doc/rst-template.txt
+
checkdoc: checkdocs
checkdocs:
epydoc --check --tests=vars,types $(PY_SRC)
@@ -166,7 +165,8 @@
mkdir -p $(HTML_DOCTEST)
$(HTML_DOCTEST)/%.html: src/epydoc/test/%.doctest
mkdir -p $(HTML_DOCTEST)
- $(RST2HTML) --stylesheet=../custom.css $< $@
+ $(RST2HTML) --stylesheet=../custom.css $< $@ \
+ --template=doc/rst-template2.txt
examples: .examples.up2date
.examples.up2date: $(EXAMPLES_SRC) $(PY_SRCFILES)
Modified: trunk/epydoc/doc/custom.css
===================================================================
--- trunk/epydoc/doc/custom.css 2007-02-27 00:07:56 UTC (rev 1553)
+++ trunk/epydoc/doc/custom.css 2007-02-27 03:31:56 UTC (rev 1554)
@@ -7,13 +7,34 @@
@import url("docutils.css");
+/*===================================================================*/
+/* Navigation box */
+
+table.navbox {
+ border-right: 1px solid black;
+ border-left: 1px solid black;
+ border-bottom: 1px solid black;
+}
+td.nav {
+ border: 2px outset #70b0ff;
+ background: #70b0ff; color: black;
+ font-weight: bold;
+}
+td.navselect {
+ background: #4888d8; color: white;
+}
+
+a.nav:link { text-decoration: none; }
+a.nav:visited { text-decoration: none; }
+
/*======================================================================*/
/* Source code colorization */
pre.py-doctest { padding: .5em; margin: 1em;
background: #e8f0f8; color: #000000;
border: 1px solid #708890; }
-table pre.py-doctest { background: #dce4ec;
- color: #000000; }
+table.docutils pre.py-doctest { background: #dce4ec;
+ color: #000000;
+ border: 1px solid #708890; }
.py-prompt { color: #005050; font-weight: bold;}
.py-string { color: #006030; }
.py-comment { color: #003060; }
@@ -44,13 +65,85 @@
h1.title { font-size: 180%; font-weight: bold; text-align: center;
padding: .1em; margin: 0; border-bottom: 2px solid black;}
+h2.subtitle { font-size: 100%; text-align: center;
+ font-style: italic; font-weight: normal; margin-top: 0; }
+
pre.literal-block { padding: .5em; margin: 1em;
background: #e8f0f8; color: #000000;
border: 1px solid #708890; }
-table.docutils { background: #e8f0f8; border: 1px solid black; }
+table.docutils {
+ border: 1px solid black; background: #e8f0f8;
+ margin-top: 6px; border-collapse: collapse;
+}
+table.docutils th, table.docutils td {
+ border: 1px solid black;
+ padding: 0 .5em 0 .5em; }
table.docutils th { background: #70b0ff; }
+div.epydoc-usage { border: 1px solid #708890;
+ background: #e8f0f8; margin: 1em; padding: 0.5em}
+table.option-list { background: none !important; }
+table.option-list td { border: none !important; }
+
+div.note {
+ border: 1px solid black; background: #e8f0f8;
+ margin-top: 6px;
+ border-collapse: collapse;
+ padding: 0 10px 10px 10px;
+}
+div.note p.admonition-title {
+ background: #a0f0c0; margin: 0 -10px; padding: 6px 6px 3px 6px;
+ border-bottom: 1px solid black;
+ }
+
+#the-epytext-markup-language table.docutils { width: 95%; }
+
+table.docutils pre { border: 0px solid black; }
+
+div.note { }
+
+
+
/* For the "Sections" example in the manual */
p.h1 { font-size: 150%; font-weight: bold; }
p.h2 { font-size: 125%; font-weight: bold; }
+
+table.docinfo { margin: 0 0 0.5em 0; font-size: 90%; }
+
+div.abstract { margin: 0; padding: 0.5em 1em;
+ border: 1px solid black;
+ background: #e8f0f8; color: black; }
+div.abstract p { margin: 0; }
+div.abstract p.topic-title { display: none; }
+
+#contents {
+ background: #e8f0f8; color: black;
+ border: 1px solid #000000;
+ margin: 1em 0 1em 0;
+ padding: 0 10px 0 10px;
+}
+
+#contents p.topic-title {
+ background: #70b0ff;
+ text-align: center;
+ font-weight: bold;
+ font-size: 125%;
+ margin: 0 -10px 0 -10px;
+ padding: 0 10px 0 10px;
+ border-bottom: 1px solid black;
+}
+
+/*
+
+<table class="docinfo" frame="void" rules="none">
+<col class="docinfo-name" />
+<col class="docinfo-content" />
+<tbody valign="top">
+<tr><th class="docinfo-name">Author:</th>
+<td><a class="first last reference" href="mailto:edloper@gradient.cis.upenn.edu">Edward Loper</a></td></tr>
+<tr><th class="docinfo-name">Version:</th>
+<td>3.0b1</td></tr>
+</tbody>
+</table>
+<div class="abstract topic">*/
\ No newline at end of file
Modified: trunk/epydoc/doc/manual-fields.txt
===================================================================
--- trunk/epydoc/doc/manual-fields.txt 2007-02-27 00:07:56 UTC (rev 1553)
+++ trunk/epydoc/doc/manual-fields.txt 2007-02-27 03:31:56 UTC (rev 1554)
@@ -90,7 +90,7 @@
of function and methods. These tags are usually put in the the docstring of the
function to be documented.
-.. note:: constructor parameters
+.. note:: **constructor parameters**
In C extension modules, extension classes cannot have a docstring attached
to the ``__init__`` function; consequently it is not possible to document
@@ -210,7 +210,7 @@
"""
#[...]
-.. note:: group markers
+.. note:: **group markers**
It is also possible to group set of related items enclosing them
into special comment starting with the *group markers* '``#{``' and '``#}``'
Modified: trunk/epydoc/doc/manual-usage.txt
===================================================================
--- trunk/epydoc/doc/manual-usage.txt 2007-02-27 00:07:56 UTC (rev 1553)
+++ trunk/epydoc/doc/manual-usage.txt 2007-02-27 03:31:56 UTC (rev 1554)
@@ -39,66 +39,68 @@
as ``epydoc/epytext.py``), or package directory names (such as ``epydoc/``).
Packages are expanded to include all sub-modules and sub-packages.
---html
- Generate HTML output. (default)
---pdf
- Generate Adobe Acrobat (PDF) output, using LaTeX.
--o DIR, --output DIR, --target DIR
- The output directory.
---parse-only, --introspect-only
- By default, epydoc will gather information about each Python object using
- two methods: parsing the object's source code; and importing the object and
- directly introspecting it. Epydoc combines the information obtained from
- these two methods to provide more complete and accurate documentation.
- However, if you wish, you can tell epydoc to use only one or the other of
- these methods. For example, if you are running epydoc on untrusted code,
- you should use the ``--parse-only`` option.
--v, -q
- Increase (``-v``) or decrease (``-q``) the verbosity of the output. These
- options may be repeated to further increase or decrease verbosity.
- Docstring markup warnings are supressed unless ``-v`` is used at least once.
---name NAME
- The documented project's name.
---url URL
- The documented project's URL.
---docformat NAME
- The markup language that should be used by default to process modules'
- docstrings. This is only used for modules that do not define the special
- ``__docformat__`` variable; it is recommended that you explicitly specify
- ``__docformat__`` in all your modules.
---graph GRAPHTYPE
- Include graphs of type *GRAPHTYPE* in the generated output. Graphs are
- generated using the Graphviz ``dot`` executable. If this executable is not
- on the path, then use ``--dotpath`` to specify its location. This option
- may be repeated to include multiple graph types in the output. To include
- all graphs, use ``--graph all``. The available graph types are:
+.. container:: epydoc-usage
- * **classtree**: displays each class's base classes and subclasses;
- * **callgraph**: displays the callers and callees of each function or
- method. These graphs are based on profiling information, which must be
- specified using the ``--pstate`` option.
- * **umlclass**: displays each class's base classes and subclasses, using
- UML style. Methods and attributes are listed in the classes where they
- are defined. If type information is available about attributes (via the
- ``@type`` field), then those types are displayed as separate classes, and
- the attributes are displayed as associations.
---inheritance STYLE
- The format that should be used to display inherited methods, variables, and
- properties. Currently, three styles are supported. To see an example of each style,
- click on it:
-
- * grouped_: Inherited objects are gathered into groups, based on which
- class they are inherited from.
- * listed_: Inherited objects are listed in a short list at the end of the
- summary table.
- * included_: Inherited objects are mixed in with non-inherited objects.
-
---config FILE
- Read the given configuration file, which can contain both options and
- Python object names. This option may be used multiple times, if you wish
- to use multiple configuration files. See `Configuration Files`_ for more
- information.
-
+ --html
+ Generate HTML output. (default)
+ --pdf
+ Generate Adobe Acrobat (PDF) output, using LaTeX.
+ -o DIR, --output DIR, --target DIR
+ The output directory.
+ --parse-only, --introspect-only
+ By default, epydoc will gather information about each Python object using
+ two methods: parsing the object's source code; and importing the object and
+ directly introspecting it. Epydoc combines the information obtained from
+ these two methods to provide more complete and accurate documentation.
+ However, if you wish, you can tell epydoc to use only one or the other of
+ these methods. For example, if you are running epydoc on untrusted code,
+ you should use the ``--parse-only`` option.
+ -v, -q
+ Increase (``-v``) or decrease (``-q``) the verbosity of the output. These
+ options may be repeated to further increase or decrease verbosity.
+ Docstring markup warnings are supressed unless ``-v`` is used at least once.
+ --name NAME
+ The documented project's name.
+ --url URL
+ The documented project's URL.
+ --docformat NAME
+ The markup language that should be used by default to process modules'
+ docstrings. This is only used for modules that do not define the special
+ ``__docformat__`` variable; it is recommended that you explicitly specify
+ ``__docformat__`` in all your modules.
+ --graph GRAPHTYPE
+ Include graphs of type *GRAPHTYPE* in the generated output. Graphs are
+ generated using the Graphviz ``dot`` executable. If this executable is not
+ on the path, then use ``--dotpath`` to specify its location. This option
+ may be repeated to include multiple graph types in the output. To include
+ all graphs, use ``--graph all``. The available graph types are:
+
+ * **classtree**: displays each class's base classes and subclasses;
+ * **callgraph**: displays the callers and callees of each function or
+ method. These graphs are based on profiling information, which must be
+ specified using the ``--pstate`` option.
+ * **umlclass**: displays each class's base classes and subclasses, using
+ UML style. Methods and attributes are listed in the classes where they
+ are defined. If type information is available about attributes (via the
+ ``@type`` field), then those types are displayed as separate classes, and
+ the attributes are displayed as associations.
+ --inheritance STYLE
+ The format that should be used to display inherited methods, variables, and
+ properties. Currently, three styles are supported. To see an example of each style,
+ click on it:
+
+ * grouped_: Inherited objects are gathered into groups, based on which
+ class they are inherited from.
+ * listed_: Inherited objects are listed in a short list at the end of the
+ summary table.
+ * included_: Inherited objects are mixed in with non-inherited objects.
+
+ --config FILE
+ Read the given configuration file, which can contain both options and
+ Python object names. This option may be used multiple times, if you wish
+ to use multiple configuration files. See `Configuration Files`_ for more
+ information.
+
.. _grouped: http://epydoc.sourceforge.net/examples/grouped/
inh_example.Programmer-class.html
.. _listed: http://epydoc.sourceforge.net/examples/listed/
Modified: trunk/epydoc/doc/manual.txt
===================================================================
--- trunk/epydoc/doc/manual.txt 2007-02-27 00:07:56 UTC (rev 1553)
+++ trunk/epydoc/doc/manual.txt 2007-02-27 03:31:56 UTC (rev 1554)
@@ -32,6 +32,7 @@
.. contents::
.. section-numbering::
+.. def:: singlepage
.. Include the document chapters
Added: trunk/epydoc/doc/rst-template.txt
===================================================================
--- trunk/epydoc/doc/rst-template.txt (rev 0)
+++ trunk/epydoc/doc/rst-template.txt 2007-02-27 03:31:56 UTC (rev 1554)
@@ -0,0 +1,36 @@
+%(head_prefix)s
+%(head)s
+%(stylesheet)s
+%(body_prefix)s
+%(body_pre_docinfo)s
+%(docinfo)s
+%(body)s
+</div>
+<table width="100%%" class="navbox" cellpadding="1" cellspacing="0">
+ <tr>
+ <a class="nav" href="index.html">
+ <td align="center" width="20%%" class="nav">
+ <a class="nav" href="index.html">
+ Home</a></td></a>
+ <a class="nav" href="installing.html">
+ <td align="center" width="20%%" class="nav">
+ <a class="nav" href="installing.html">
+ Installing Epydoc</a></td></a>
+ <a class="nav" href="using.html">
+ <td align="center" width="20%%" class="nav">
+ <a class="nav" href="using.html">
+ Using Epydoc</a></td></a>
+ <a class="nav" href="epytext.html">
+ <td align="center" width="20%%" class="nav">
+ <a class="nav" href="epytext.html">
+ Epytext</a></td></a>
+ <td align="center" width="20%%" class="nav">
+
+ <A href="http://sourceforge.net/projects/epydoc">
+ <IMG src="sflogo.png"
+ width="88" height="26" border="0" alt="SourceForge"
+ align="top"/></A></td>
+ </tr>
+</table>
+</body>
+</html>
Added: trunk/epydoc/doc/rst-template2.txt
===================================================================
--- trunk/epydoc/doc/rst-template2.txt (rev 0)
+++ trunk/epydoc/doc/rst-template2.txt 2007-02-27 03:31:56 UTC (rev 1554)
@@ -0,0 +1,36 @@
+%(head_prefix)s
+%(head)s
+%(stylesheet)s
+%(body_prefix)s
+%(body_pre_docinfo)s
+%(docinfo)s
+%(body)s
+</div>
+<table width="100%%" class="navbox" cellpadding="1" cellspacing="0">
+ <tr>
+ <a class="nav" href="../index.html">
+ <td align="center" width="20%%" class="nav">
+ <a class="nav" href="../index.html">
+ Home</a></td></a>
+ <a class="nav" href="../installing.html">
+ <td align="center" width="20%%" class="nav">
+ <a class="nav" href="../installing.html">
+ Installing Epydoc</a></td></a>
+ <a class="nav" href="../using.html">
+ <td align="center" width="20%%" class="nav">
+ <a class="nav" href="../using.html">
+ Using Epydoc</a></td></a>
+ <a class="nav" href="../epytext.html">
+ <td align="center" width="20%%" class="nav">
+ <a class="nav" href="../epytext.html">
+ Epytext</a></td></a>
+ <td align="center" width="20%%" class="nav">
+
+ <A href="http://sourceforge.net/projects/epydoc">
+ <IMG src="../sflogo.png"
+ width="88" height="26" border="0" alt="SourceForge"
+ align="top"/></A></td>
+ </tr>
+</table>
+</body>
+</html>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
