diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/build_docs.py | 70 | ||||
| -rw-r--r-- | docs/docs.conf | 3 | ||||
| -rw-r--r-- | docs/write_addons.rst | 15 | ||||
| -rw-r--r-- | docs/write_plugins.rst | 2 |
4 files changed, 47 insertions, 43 deletions
diff --git a/docs/build_docs.py b/docs/build_docs.py index 8a7ab7a18..05f34be44 100644 --- a/docs/build_docs.py +++ b/docs/build_docs.py @@ -25,12 +25,12 @@ sys.path.append(dir_name) # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +# sys.path.insert(0, os.path.abspath('.')) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +# needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. @@ -50,7 +50,7 @@ templates_path = ['_templates'] source_suffix = '.rst' # The encoding of source files. -#source_encoding = 'utf-8-sig' +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' @@ -79,37 +79,37 @@ release = '0.4.10' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] +# modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- @@ -121,17 +121,17 @@ html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # "<project> v<release> documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. @@ -149,44 +149,44 @@ html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' +# html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_domain_indices = True +# html_domain_indices = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a <link> tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'pyLoaddoc' @@ -195,10 +195,10 @@ htmlhelp_basename = 'pyLoaddoc' # -- Options for LaTeX output -------------------------------------------------- # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +# latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +# latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). @@ -209,26 +209,26 @@ latex_documents = [ # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # If true, show page references after internal links. -#latex_show_pagerefs = False +# latex_show_pagerefs = False # If true, show URL addresses after external links. -#latex_show_urls = False +# latex_show_urls = False # Additional stuff for the LaTeX preamble. -#latex_preamble = '' +# latex_preamble = '' # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_domain_indices = True +# latex_domain_indices = True # -- Options for manual page output -------------------------------------------- diff --git a/docs/docs.conf b/docs/docs.conf index 61a2c45ee..c5e619fd6 100644 --- a/docs/docs.conf +++ b/docs/docs.conf @@ -1,5 +1,6 @@ -#@NOTE: usage: epydoc --conf docs.conf , results goes to ~/.pyload/docs +#@NOTE: usage: epydoc --conf docs.conf +# results goes to ~/.pyload/docs [epydoc] diff --git a/docs/write_addons.rst b/docs/write_addons.rst index b7f6dfdb8..58e73e675 100644 --- a/docs/write_addons.rst +++ b/docs/write_addons.rst @@ -20,12 +20,15 @@ All addons should start with something like this: :: class YourAddon(Addon): - __name = "YourAddon" + __name = "YourAddon" + __tupe = "addon" __version = "0.1" + + __config = [("activated", "bool", "Activated", "True")] + __description = "Does really cool stuff" - __config = [ ("activated" , "bool" , "Activated" , "True" ) ] - __author_name__ = ("Me") - __author_mail__ = ("me@has-no-mail.com") + __license = "Your license short name" + __authors = [("Me", "me@has-no-mail.com")] All meta-data is defined in the header, you need at least one option at ``__config`` so the user can toggle your addon on and off. Dont't overwrite the ``init`` method if not neccesary, use ``setup`` instead. @@ -130,7 +133,7 @@ Sounds complicated but is very easy to do. Just use the ``Expose`` decorator: :: Thats all, it's available via the :class:`Api <pyload.api.Api>` now. If you want to use it read :ref:`access_api`. Here is a basic example: :: - #Assuming client is a ThriftClient or Api object + # Assuming client is a ThriftClient or Api object print client.getServices() print client.call(ServiceCall("YourAddon", "invoke", "an argument")) @@ -158,7 +161,7 @@ Just store everything in ``self.info``. :: Usable with: :: - #Assuming client is a ThriftClient or Api object + # Assuming client is a ThriftClient or Api object print client.getAllInfo() diff --git a/docs/write_plugins.rst b/docs/write_plugins.rst index af35a8d55..8d42aea7f 100644 --- a/docs/write_plugins.rst +++ b/docs/write_plugins.rst @@ -51,7 +51,7 @@ An example ``process`` function could look like this :: """ def process(self, pyfile): - html = self.load(pyfile.url) # load the content of the orginal pyfile.url to html + html = self.load(pyfile.url) #: load the content of the orginal pyfile.url to html # parse the name from the site and set attribute in pyfile pyfile.name = self.myFunctionToParseTheName(html) |