From: Cameron Dale Date: Thu, 21 Feb 2008 04:59:58 +0000 (-0800) Subject: Add and clean up some of the epydoc documentation. X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=99242333df43581eb351665681617ec02ca7e074;p=quix0rs-apt-p2p.git Add and clean up some of the epydoc documentation. --- diff --git a/.gitignore b/.gitignore index 2c4f8e9..20a19f4 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ .pydevproject *.pyc _trial_temp +docs/html diff --git a/apt_dht/AptPackages.py b/apt_dht/AptPackages.py index 3e1c035..2793c4e 100644 --- a/apt_dht/AptPackages.py +++ b/apt_dht/AptPackages.py @@ -121,8 +121,7 @@ class AptPackages: def __init__(self, cache_dir): """Construct a new packages manager. - @ivar backendName: name of backend associated with this packages file - @ivar cache_dir: cache directory from config file + @param cache_dir: cache directory from config file """ self.cache_dir = cache_dir self.apt_config = deepcopy(self.DEFAULT_APT_CONFIG) diff --git a/apt_dht/__init__.py b/apt_dht/__init__.py index 82d30c8..6140baf 100644 --- a/apt_dht/__init__.py +++ b/apt_dht/__init__.py @@ -15,7 +15,7 @@ Diagram of the interaction between the given modules:: | | | PeerManager | | HTTPDownloader*| | | |--->|get |--->|get HTTP|----|---> Mirror | | | |--->|getRange | | - | |--->|close |--->|close HTTP|----|--\ + | |--->|close |--->|close HTTP|----|--\ | | +-------------+ +----------------+ | | | | +-----------------------------------+ | | Another | | | HTTPServer | | | Peer diff --git a/docs/epydoc.config b/docs/epydoc.config new file mode 100644 index 0000000..7435dd0 --- /dev/null +++ b/docs/epydoc.config @@ -0,0 +1,149 @@ +[epydoc] # Epydoc section marker (required by ConfigParser) + +# The list of objects to document. Objects can be named using +# dotted names, module filenames, or package directory names. +# Alases for this option include "objects" and "values". +modules: apt_dht apt_dht_Khashmir test.py + +# The type of output that should be generated. Should be one +# of: html, text, latex, dvi, ps, pdf. +output: html + +# The path to the output directory. May be relative or absolute. +target: docs/html/ + +# An integer indicating how verbose epydoc should be. The default +# value is 0; negative values will supress warnings and errors; +# positive values will give more verbose output. +verbosity: 0 + +# A boolean value indicating that Epydoc should show a tracaback +# in case of unexpected error. By default don't show tracebacks +debug: 0 + +# If True, don't try to use colors or cursor control when doing +# textual output. The default False assumes a rich text prompt +simple-term: 0 + + +### Generation options + +# The default markup language for docstrings, for modules that do +# not define __docformat__. Defaults to epytext. +docformat: epytext + +# Whether or not parsing should be used to examine objects. +parse: yes + +# Whether or not introspection should be used to examine objects. +introspect: yes + +# Don't examine in any way the modules whose dotted name match this +# regular expression pattern. +#exclude + +# Don't perform introspection on the modules whose dotted name match this +# regular expression pattern. +#exclude-introspect + +# Don't perform parsing on the modules whose dotted name match this +# regular expression pattern. +#exclude-parse + +# The format for showing inheritance objects. +# It should be one of: 'grouped', 'listed', 'included'. +inheritance: grouped + +# Whether or not to inclue private variables. (Even if included, +# private variables will be hidden by default.) +private: yes + +# Whether or not to list each module's imports. +imports: yes + +# Whether or not to include syntax highlighted source code in +# the output (HTML only). +sourcecode: yes + +# Whether or not to includea a page with Epydoc log, containing +# effective option at the time of generation and the reported logs. +include-log: yes + + +### Output options + +# The documented project's name. +name: Apt-DHT + +# The CSS stylesheet for HTML output. Can be the name of a builtin +# stylesheet, or the name of a file. +css: white + +# The documented project's URL. +url: http://www.camrdale.org/apt-dht.html + +# HTML code for the project link in the navigation bar. If left +# unspecified, the project link will be generated based on the +# project's name and URL. +#link: My Cool Project + +# The "top" page for the documentation. Can be a URL, the name +# of a module or class, or one of the special names "trees.html", +# "indices.html", or "help.html" +#top: os.path + +# An alternative help file. The named file should contain the +# body of an HTML file; navigation bars will be added to it. +#help: my_helpfile.html + +# Whether or not to include a frames-based table of contents. +frames: yes + +# Whether each class should be listed in its own section when +# generating LaTeX or PDF output. +separate-classes: no + + +### API linking options + +# Define a new API document. A new interpreted text role +# will be created +#external-api: epydoc + +# Use the records in this file to resolve objects in the API named NAME. +#external-api-file: epydoc:api-objects.txt + +# Use this URL prefix to configure the string returned for external API. +#external-api-root: epydoc:http://epydoc.sourceforge.net/api + + +### Graph options + +# The list of graph types that should be automatically included +# in the output. Graphs are generated using the Graphviz "dot" +# executable. Graph types include: "classtree", "callgraph", +# "umlclass". Use "all" to include all graph types +graph: all + +# The path to the Graphviz "dot" executable, used to generate +# graphs. +#dotpath: /usr/local/bin/dot + +# The name of one or more pstat files (generated by the profile +# or hotshot module). These are used to generate call graphs. +#pstat: docs/pstat/debtorrent-client.pstat + +# Specify the font used to generate Graphviz graphs. +# (e.g., helvetica or times). +graph-font: Helvetica + +# Specify the font size used to generate Graphviz graphs. +graph-font-size: 10 + + +### Return value options + +# The condition upon which Epydoc should exit with a non-zero +# exit status. Possible values are error, warning, docstring_warning +#fail-on: error +