Thread: [Epydoc-commits] SF.net SVN: epydoc: [1192] trunk/epydoc/src/epydoc/__init__.py
Brought to you by:
edloper
From: <ed...@us...> - 2006-04-07 23:40:11
|
Revision: 1192 Author: edloper Date: 2006-04-07 16:40:05 -0700 (Fri, 07 Apr 2006) ViewCVS: http://svn.sourceforge.net/epydoc/?rev=1192&view=rev Log Message: ----------- - Docstring updates Modified Paths: -------------- trunk/epydoc/src/epydoc/__init__.py Modified: trunk/epydoc/src/epydoc/__init__.py =================================================================== --- trunk/epydoc/src/epydoc/__init__.py 2006-04-07 23:39:46 UTC (rev 1191) +++ trunk/epydoc/src/epydoc/__init__.py 2006-04-07 23:40:05 UTC (rev 1192) @@ -18,37 +18,37 @@ that are related to them (such as the values defined by a module). This can be done via introspection, parsing, or both: - * Use introspection to examine the objects directly. + * *Introspection* imports the objects, and examines them directly + using Python's introspection mechanisms. - * Parse the Python source files that define the objects, - and extract information from those files. + * *Parsing* reads the Python source files that define the objects, + and extracts information from those files. 2. Combine and process that information. - * Merge the information obtained from introspection & parsing - each object into a single structure. (This step is skipped if - information was extracted from only introspection or only - parsing.) + * **Merging**: Merge the information obtained from introspection & + parsing each object into a single structure. - * Replace any 'pointers' that were created for imported - variables with the documentation that they point to (if it's - available). + * **Linking**: Replace any \"pointers\" that were created for + imported variables with the documentation that they point to. - * Assign unique 'canonical names' to each of the specified - objects, and any related objects. + * **Naming**: Assign unique *canonical names* to each of the + specified objects, and any related objects. - * Parse the docstrings of each of the specified objects, and any - related objects. + * **Docstrings**: Parse the docstrings of each of the specified + objects. - * Add variables to classes for any values that they inherit from - their base classes. + * **Inheritance**: Add variables to classes for any values that + they inherit from their base classes. 3. Generate output. Output can be generated in a variety of formats: - * An HTML webpage + * An HTML webpage. - * other formats (under construction) + * A LaTeX document (which can be rendered as a PDF file) + * A plaintext description. + .. digraph:: Overview of epydoc's architecture :caption: The boxes represent steps in epydoc's processing chain. Arrows are annotated with the data classes used to @@ -113,10 +113,25 @@ href="<docbuilder.build_doc_index>"] l1 -> l2 [label=" epydoc.\\l cli()", href="<cli>"] } - { rank=same; l1 l3 introspect } + { rank=same; l1 l3 input } { rank=same; l2 write_html } { rank=same; l4 output } +Package Organization +==================== +The epydoc package contains the following subpackages and modules: + +.. packagetree:: + :style: UML + +The user interfaces are provided by the `gui` and `cli` modules. +The `apidoc` module defines the basic data types used to record +information about Python objects. The programmatic interface to +epydoc is provided by `docbuilder`. Docstring markup parsing is +handled by the `markup` package, and output generation is handled by +the `docwriter` package. See the submodule list for more +information about the submodules and subpackages. + :group User Interface: gui, cli :group Basic Data Types: apidoc :group Documentation Generation: docbuilder, docintrospecter, docparser This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2006-04-09 20:45:31
|
Revision: 1199 Author: edloper Date: 2006-04-09 13:45:24 -0700 (Sun, 09 Apr 2006) ViewCVS: http://svn.sourceforge.net/epydoc/?rev=1199&view=rev Log Message: ----------- - Added ascii version of architecture diagram Modified Paths: -------------- trunk/epydoc/src/epydoc/__init__.py Modified: trunk/epydoc/src/epydoc/__init__.py =================================================================== --- trunk/epydoc/src/epydoc/__init__.py 2006-04-09 20:43:09 UTC (rev 1198) +++ trunk/epydoc/src/epydoc/__init__.py 2006-04-09 20:45:24 UTC (rev 1199) @@ -56,6 +56,31 @@ side mark what portions of the processing chain are initiated by build_doc_index() and cli(). Click on any item to see its documentation. + + /* + Python module or value * * + / \ | | + V V | | + introspect_docs() parse_docs() | | + \ / | | + V V | | + merge_docs() | | + | build_doc_index() cli() + V | | + link_imports() | | + | | | + V | | + assign_canonical_names() | | + | | | + V | | + parse_docstrings() | | + | | | + V | | + inherit_docs() * | + / | \ | + V V V | + HTMLWriter LaTeXWriter PlaintextWriter * + */ ranksep = 0.1; node [shape="box", height="0", width="0"] This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2006-08-23 20:08:56
|
Revision: 1313 Author: edloper Date: 2006-08-23 13:08:52 -0700 (Wed, 23 Aug 2006) ViewCVS: http://svn.sourceforge.net/epydoc/?rev=1313&view=rev Log Message: ----------- - Bumped version number to alpha3 Modified Paths: -------------- trunk/epydoc/src/epydoc/__init__.py Modified: trunk/epydoc/src/epydoc/__init__.py =================================================================== --- trunk/epydoc/src/epydoc/__init__.py 2006-08-23 16:44:57 UTC (rev 1312) +++ trunk/epydoc/src/epydoc/__init__.py 2006-08-23 20:08:52 UTC (rev 1313) @@ -202,7 +202,7 @@ """ __docformat__ = 'restructuredtext en' -__version__ = '3.0alpha2' +__version__ = '3.0alpha3' """The version of epydoc""" __author__ = 'Edward Loper <ed...@gr...>' This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2006-04-11 17:27:00
|
Revision: 1214 Author: edloper Date: 2006-04-11 10:26:56 -0700 (Tue, 11 Apr 2006) ViewCVS: http://svn.sourceforge.net/epydoc/?rev=1214&view=rev Log Message: ----------- - Bumped version number to 3.0alpha2 Modified Paths: -------------- trunk/epydoc/src/epydoc/__init__.py Modified: trunk/epydoc/src/epydoc/__init__.py =================================================================== --- trunk/epydoc/src/epydoc/__init__.py 2006-04-10 20:05:45 UTC (rev 1213) +++ trunk/epydoc/src/epydoc/__init__.py 2006-04-11 17:26:56 UTC (rev 1214) @@ -167,7 +167,7 @@ :author: `Edward Loper <ed...@gr...>`__ :requires: Python 2.3+ -:version: 3.0 alpha +:version: 3.0 alpha 2 :see: `The epydoc webpage <http://epydoc.sourceforge.net>`__ :see: `The epytext markup language manual <http://epydoc.sourceforge.net/epytext.html>`__ @@ -198,7 +198,7 @@ """ __docformat__ = 'restructuredtext en' -__version__ = '3.0alpha' +__version__ = '3.0alpha2' """The version of epydoc""" __author__ = 'Edward Loper <ed...@gr...>' This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2006-04-12 19:51:25
|
Revision: 1224 Author: edloper Date: 2006-04-12 12:51:07 -0700 (Wed, 12 Apr 2006) ViewCVS: http://svn.sourceforge.net/epydoc/?rev=1224&view=rev Log Message: ----------- - Added a couple notes about bugs Modified Paths: -------------- trunk/epydoc/src/epydoc/__init__.py Modified: trunk/epydoc/src/epydoc/__init__.py =================================================================== --- trunk/epydoc/src/epydoc/__init__.py 2006-04-12 19:50:43 UTC (rev 1223) +++ trunk/epydoc/src/epydoc/__init__.py 2006-04-12 19:51:07 UTC (rev 1224) @@ -182,6 +182,10 @@ don't construct docs for imported modules' vars if it's not necessary) +:bug: UserDict.* is interpreted as imported .. why?? +:bug: Nested functions break source colorizer (and *why* is the source + colorizer being so slow on the stdlib???) + :license: IBM Open Source License :copyright: |copy| 2006 Edward Loper This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2006-09-03 03:40:34
|
Revision: 1347 http://svn.sourceforge.net/epydoc/?rev=1347&view=rev Author: edloper Date: 2006-09-02 20:40:30 -0700 (Sat, 02 Sep 2006) Log Message: ----------- - Turned off debug flag (optimizing epydoc for speed) Modified Paths: -------------- trunk/epydoc/src/epydoc/__init__.py Modified: trunk/epydoc/src/epydoc/__init__.py =================================================================== --- trunk/epydoc/src/epydoc/__init__.py 2006-09-03 03:39:58 UTC (rev 1346) +++ trunk/epydoc/src/epydoc/__init__.py 2006-09-03 03:40:30 UTC (rev 1347) @@ -213,7 +213,7 @@ """The license governing the use and distribution of epydoc""" # [xx] this should probably be a private variable: -DEBUG = True +DEBUG = False """True if debugging is turned on.""" # Changes needed for docs: This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-01-30 01:55:15
|
Revision: 1684 http://epydoc.svn.sourceforge.net/epydoc/?rev=1684&view=rev Author: edloper Date: 2008-01-29 17:55:13 -0800 (Tue, 29 Jan 2008) Log Message: ----------- - Updated version string Modified Paths: -------------- trunk/epydoc/src/epydoc/__init__.py Modified: trunk/epydoc/src/epydoc/__init__.py =================================================================== --- trunk/epydoc/src/epydoc/__init__.py 2008-01-29 22:17:39 UTC (rev 1683) +++ trunk/epydoc/src/epydoc/__init__.py 2008-01-30 01:55:13 UTC (rev 1684) @@ -167,7 +167,7 @@ :author: `Edward Loper <ed...@gr...>`__ :requires: Python 2.3+ -:version: 3.0 beta 1 +:version: 3.0 :see: `The epydoc webpage <http://epydoc.sourceforge.net>`__ :see: `The epytext markup language manual <http://epydoc.sourceforge.net/epytext.html>`__ @@ -200,7 +200,7 @@ """ __docformat__ = 'restructuredtext en' -__version__ = '3.0beta1' +__version__ = '3.0' """The version of epydoc""" __author__ = 'Edward Loper <ed...@gr...>' This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-01-30 17:11:18
|
Revision: 1691 http://epydoc.svn.sourceforge.net/epydoc/?rev=1691&view=rev Author: edloper Date: 2008-01-30 09:11:09 -0800 (Wed, 30 Jan 2008) Log Message: ----------- - Bumped version to 3.0.1, for the GUI fix. Modified Paths: -------------- trunk/epydoc/src/epydoc/__init__.py Modified: trunk/epydoc/src/epydoc/__init__.py =================================================================== --- trunk/epydoc/src/epydoc/__init__.py 2008-01-30 17:07:10 UTC (rev 1690) +++ trunk/epydoc/src/epydoc/__init__.py 2008-01-30 17:11:09 UTC (rev 1691) @@ -167,7 +167,7 @@ :author: `Edward Loper <ed...@gr...>`__ :requires: Python 2.3+ -:version: 3.0 +:version: 3.0.1 :see: `The epydoc webpage <http://epydoc.sourceforge.net>`__ :see: `The epytext markup language manual <http://epydoc.sourceforge.net/epytext.html>`__ @@ -200,7 +200,7 @@ """ __docformat__ = 'restructuredtext en' -__version__ = '3.0' +__version__ = '3.0.1' """The version of epydoc""" __author__ = 'Edward Loper <ed...@gr...>' This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
From: <ed...@us...> - 2008-02-23 16:10:04
|
Revision: 1750 http://epydoc.svn.sourceforge.net/epydoc/?rev=1750&view=rev Author: edloper Date: 2008-02-23 08:09:47 -0800 (Sat, 23 Feb 2008) Log Message: ----------- - Added Jonathan Guyer to the contributors list Modified Paths: -------------- trunk/epydoc/src/epydoc/__init__.py Modified: trunk/epydoc/src/epydoc/__init__.py =================================================================== --- trunk/epydoc/src/epydoc/__init__.py 2008-02-23 07:02:42 UTC (rev 1749) +++ trunk/epydoc/src/epydoc/__init__.py 2008-02-23 16:09:47 UTC (rev 1750) @@ -195,6 +195,7 @@ :contributor: `Simon Pamies <mailto:sp...@bi...>`__ :contributor: `Christian Reis <mailto:ki...@as...>`__ :contributor: `Daniele Varrazzo <mailto:dan...@gm...>`__ +:contributor: `Jonathan Guyer <mailto:gu...@ni...>`__ .. |copy| unicode:: 0xA9 .. copyright sign """ This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |