From baead802a59bf3031b2ecb416bab2336a26d1747 Mon Sep 17 00:00:00 2001 From: niphlod Date: Sun, 6 Apr 2014 20:50:02 +0200 Subject: [PATCH] sphinx compatible doc-generation --- docs/Makefile | 182 ++++++++++++++++++++++++ docs/admin.rst | 8 ++ docs/cache.rst | 8 ++ docs/cfs.rst | 8 ++ docs/compileapp.rst | 8 ++ docs/conf.py | 249 +++++++++++++++++++++++++++++++++ docs/contenttype.rst | 8 ++ docs/custom_import.rst | 8 ++ docs/dal.rst | 8 ++ docs/debug.rst | 8 ++ docs/decoder.rst | 8 ++ docs/fileutils.rst | 8 ++ docs/globals.rst | 8 ++ docs/highlight.rst | 8 ++ docs/html.rst | 8 ++ docs/http.rst | 8 ++ docs/index.rst | 58 ++++++++ docs/languages.rst | 8 ++ docs/main.rst | 8 ++ docs/messageboxhandler.rst | 8 ++ docs/myregex.rst | 8 ++ docs/newcron.rst | 8 ++ docs/portalocker.rst | 8 ++ docs/requirements.txt | 1 + docs/reserved_sql_keywords.rst | 9 ++ docs/restricted.rst | 8 ++ docs/rewrite.rst | 8 ++ docs/sanitizer.rst | 8 ++ docs/scheduler.rst | 8 ++ docs/serializers.rst | 8 ++ docs/settings.rst | 8 ++ docs/shell.rst | 8 ++ docs/sql.rst | 8 ++ docs/sqlhtml.rst | 8 ++ docs/storage.rst | 8 ++ docs/streamer.rst | 8 ++ docs/template.rst | 8 ++ docs/tools.rst | 8 ++ docs/utf8.rst | 8 ++ docs/utils.rst | 8 ++ docs/validators.rst | 8 ++ docs/widget.rst | 8 ++ docs/xmlrpc.rst | 9 ++ 43 files changed, 804 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/admin.rst create mode 100644 docs/cache.rst create mode 100644 docs/cfs.rst create mode 100644 docs/compileapp.rst create mode 100644 docs/conf.py create mode 100644 docs/contenttype.rst create mode 100644 docs/custom_import.rst create mode 100644 docs/dal.rst create mode 100644 docs/debug.rst create mode 100644 docs/decoder.rst create mode 100644 docs/fileutils.rst create mode 100644 docs/globals.rst create mode 100644 docs/highlight.rst create mode 100644 docs/html.rst create mode 100644 docs/http.rst create mode 100644 docs/index.rst create mode 100644 docs/languages.rst create mode 100644 docs/main.rst create mode 100644 docs/messageboxhandler.rst create mode 100644 docs/myregex.rst create mode 100644 docs/newcron.rst create mode 100644 docs/portalocker.rst create mode 100644 docs/requirements.txt create mode 100644 docs/reserved_sql_keywords.rst create mode 100644 docs/restricted.rst create mode 100644 docs/rewrite.rst create mode 100644 docs/sanitizer.rst create mode 100644 docs/scheduler.rst create mode 100644 docs/serializers.rst create mode 100644 docs/settings.rst create mode 100644 docs/shell.rst create mode 100644 docs/sql.rst create mode 100644 docs/sqlhtml.rst create mode 100644 docs/storage.rst create mode 100644 docs/streamer.rst create mode 100644 docs/template.rst create mode 100644 docs/tools.rst create mode 100644 docs/utf8.rst create mode 100644 docs/utils.rst create mode 100644 docs/validators.rst create mode 100644 docs/widget.rst create mode 100644 docs/xmlrpc.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..61b421c7 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,182 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + rm -rf applications/ + rm -rf site-packages/ + rm -rf logs/ + rm -rf deposit/ + rm VERSION + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/gluon.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/gluon.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/gluon" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/gluon" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/admin.rst b/docs/admin.rst new file mode 100644 index 00000000..2aa14ff4 --- /dev/null +++ b/docs/admin.rst @@ -0,0 +1,8 @@ + +:mod:`admin` Module +------------------- + +.. automodule:: gluon.admin + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/cache.rst b/docs/cache.rst new file mode 100644 index 00000000..fa3cde4a --- /dev/null +++ b/docs/cache.rst @@ -0,0 +1,8 @@ + +:mod:`cache` Module +------------------- + +.. automodule:: gluon.cache + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/docs/cfs.rst b/docs/cfs.rst new file mode 100644 index 00000000..97d33929 --- /dev/null +++ b/docs/cfs.rst @@ -0,0 +1,8 @@ + +:mod:`cfs` Module +----------------- + +.. automodule:: gluon.cfs + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/compileapp.rst b/docs/compileapp.rst new file mode 100644 index 00000000..df53571f --- /dev/null +++ b/docs/compileapp.rst @@ -0,0 +1,8 @@ + +:mod:`compileapp` Module +------------------------ + +.. automodule:: gluon.compileapp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..514dcfd8 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,249 @@ +# -*- coding: utf-8 -*- +# +# web2py documentation build configuration file, created by +# sphinx-quickstart on Sun Aug 18 20:05:19 2013. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os, shutil +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# 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('..')) +shutil.copy(os.path.join('..', 'VERSION'), 'VERSION') +from gluon.fileutils import parse_version +vfile = open('VERSION') +contents = vfile.read() +vfile.close() +version_tuple = parse_version(contents) +_version = "%s-%s" % ('.'.join(['%s' % a for a in version_tuple[:3]]), version_tuple[3]) +_release = _version +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#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. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'sphinxcontrib.napoleon'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'web2py' +copyright = u'2014, web2py-developers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = _version +# The full version, including alpha/beta/rc tags. +release = _release + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#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 + +# If true, '()' will be appended to :func: etc. cross-reference text. +#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 + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#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 = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output --------------------------------------------------- + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#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' + +# 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 = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +html_show_sourcelink = False + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'web2pydoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'web2py.tex', u'web2py Documentation', + u'web2py-developers', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'web2py', u'web2py Documentation', + [u'web2py-developers'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'web2py', u'web2py Documentation', + u'web2py-developers', 'web2py', 'web2py web framework', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/contenttype.rst b/docs/contenttype.rst new file mode 100644 index 00000000..4c3c514f --- /dev/null +++ b/docs/contenttype.rst @@ -0,0 +1,8 @@ + +:mod:`contenttype` Module +------------------------- + +.. automodule:: gluon.contenttype + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/custom_import.rst b/docs/custom_import.rst new file mode 100644 index 00000000..d430bcc9 --- /dev/null +++ b/docs/custom_import.rst @@ -0,0 +1,8 @@ + +:mod:`custom_import` Module +--------------------------- + +.. automodule:: gluon.custom_import + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/dal.rst b/docs/dal.rst new file mode 100644 index 00000000..5208ed87 --- /dev/null +++ b/docs/dal.rst @@ -0,0 +1,8 @@ + +:mod:`dal` Module +----------------- + +.. automodule:: gluon.dal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/debug.rst b/docs/debug.rst new file mode 100644 index 00000000..ab454037 --- /dev/null +++ b/docs/debug.rst @@ -0,0 +1,8 @@ + +:mod:`debug` Module +------------------- + +.. automodule:: gluon.debug + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/decoder.rst b/docs/decoder.rst new file mode 100644 index 00000000..53cc3609 --- /dev/null +++ b/docs/decoder.rst @@ -0,0 +1,8 @@ + +:mod:`decoder` Module +--------------------- + +.. automodule:: gluon.decoder + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/fileutils.rst b/docs/fileutils.rst new file mode 100644 index 00000000..bafc64bf --- /dev/null +++ b/docs/fileutils.rst @@ -0,0 +1,8 @@ + +:mod:`fileutils` Module +----------------------- + +.. automodule:: gluon.fileutils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/globals.rst b/docs/globals.rst new file mode 100644 index 00000000..a1fa4e62 --- /dev/null +++ b/docs/globals.rst @@ -0,0 +1,8 @@ + +:mod:`globals` Module +--------------------- + +.. automodule:: gluon.globals + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/highlight.rst b/docs/highlight.rst new file mode 100644 index 00000000..43577f85 --- /dev/null +++ b/docs/highlight.rst @@ -0,0 +1,8 @@ + +:mod:`highlight` Module +----------------------- + +.. automodule:: gluon.highlight + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/html.rst b/docs/html.rst new file mode 100644 index 00000000..2ddac954 --- /dev/null +++ b/docs/html.rst @@ -0,0 +1,8 @@ + +:mod:`html` Module +------------------ + +.. automodule:: gluon.html + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/http.rst b/docs/http.rst new file mode 100644 index 00000000..35d9a4e6 --- /dev/null +++ b/docs/http.rst @@ -0,0 +1,8 @@ + +:mod:`http` Module +-------------------- + +.. automodule:: gluon.http + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..b113c737 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,58 @@ + +Welcome to web2py's API documentation! +====================================== + +Contents: + +.. toctree:: + :maxdepth: 4 + + admin + cache + cfs + compileapp + contenttype + custom_import + dal + debug + decoder + fileutils + globals + highlight + html + http + languages + main + messageboxhandler + myregex + newcron + portalocker + reserved_sql_keywords + restricted + rewrite + sanitizer + scheduler + serializers + settings + shell + sql + sqlhtml + storage + streamer + template + tools + utf8 + utils + validators + widget + xmlrpc + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/languages.rst b/docs/languages.rst new file mode 100644 index 00000000..785979de --- /dev/null +++ b/docs/languages.rst @@ -0,0 +1,8 @@ + +:mod:`languages` Module +----------------------- + +.. automodule:: gluon.languages + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/main.rst b/docs/main.rst new file mode 100644 index 00000000..09518e09 --- /dev/null +++ b/docs/main.rst @@ -0,0 +1,8 @@ + +:mod:`main` Module +-------------------- + +.. automodule:: gluon.main + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/messageboxhandler.rst b/docs/messageboxhandler.rst new file mode 100644 index 00000000..d7933088 --- /dev/null +++ b/docs/messageboxhandler.rst @@ -0,0 +1,8 @@ + +:mod:`messageboxhandler` Module +------------------------------- + +.. automodule:: gluon.messageboxhandler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/myregex.rst b/docs/myregex.rst new file mode 100644 index 00000000..4c3af3a1 --- /dev/null +++ b/docs/myregex.rst @@ -0,0 +1,8 @@ + +:mod:`myregex` Module +--------------------- + +.. automodule:: gluon.myregex + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/newcron.rst b/docs/newcron.rst new file mode 100644 index 00000000..a9f1fbc1 --- /dev/null +++ b/docs/newcron.rst @@ -0,0 +1,8 @@ + +:mod:`newcron` Module +--------------------- + +.. automodule:: gluon.newcron + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/portalocker.rst b/docs/portalocker.rst new file mode 100644 index 00000000..971437a4 --- /dev/null +++ b/docs/portalocker.rst @@ -0,0 +1,8 @@ + +:mod:`portalocker` Module +------------------------- + +.. automodule:: gluon.portalocker + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..49ea3af7 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinxcontrib-napoleon>=0.2.4 \ No newline at end of file diff --git a/docs/reserved_sql_keywords.rst b/docs/reserved_sql_keywords.rst new file mode 100644 index 00000000..c9db97b7 --- /dev/null +++ b/docs/reserved_sql_keywords.rst @@ -0,0 +1,9 @@ + +:mod:`reserved_sql_keywords` Module +----------------------------------- + + +.. automodule:: gluon.reserved_sql_keywords + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/restricted.rst b/docs/restricted.rst new file mode 100644 index 00000000..b9e1e7ea --- /dev/null +++ b/docs/restricted.rst @@ -0,0 +1,8 @@ + +:mod:`restricted` Module +------------------------ + +.. automodule:: gluon.restricted + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/rewrite.rst b/docs/rewrite.rst new file mode 100644 index 00000000..68dcd2a1 --- /dev/null +++ b/docs/rewrite.rst @@ -0,0 +1,8 @@ + +:mod:`rewrite` Module +--------------------- + +.. automodule:: gluon.rewrite + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sanitizer.rst b/docs/sanitizer.rst new file mode 100644 index 00000000..3ed7f356 --- /dev/null +++ b/docs/sanitizer.rst @@ -0,0 +1,8 @@ + +:mod:`sanitizer` Module +----------------------- + +.. automodule:: gluon.sanitizer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/scheduler.rst b/docs/scheduler.rst new file mode 100644 index 00000000..846a525d --- /dev/null +++ b/docs/scheduler.rst @@ -0,0 +1,8 @@ + +:mod:`scheduler` Module +----------------------- + +.. automodule:: gluon.scheduler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/serializers.rst b/docs/serializers.rst new file mode 100644 index 00000000..9c8e7108 --- /dev/null +++ b/docs/serializers.rst @@ -0,0 +1,8 @@ + +:mod:`serializers` Module +------------------------- + +.. automodule:: gluon.serializers + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/settings.rst b/docs/settings.rst new file mode 100644 index 00000000..88ae1938 --- /dev/null +++ b/docs/settings.rst @@ -0,0 +1,8 @@ + +:mod:`settings` Module +---------------------- + +.. automodule:: gluon.settings + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/shell.rst b/docs/shell.rst new file mode 100644 index 00000000..23378ef0 --- /dev/null +++ b/docs/shell.rst @@ -0,0 +1,8 @@ + +:mod:`shell` Module +-------------------- + +.. automodule:: gluon.shell + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sql.rst b/docs/sql.rst new file mode 100644 index 00000000..e2693a96 --- /dev/null +++ b/docs/sql.rst @@ -0,0 +1,8 @@ + +:mod:`sql` Module +-------------------- + +.. automodule:: gluon.sql + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/sqlhtml.rst b/docs/sqlhtml.rst new file mode 100644 index 00000000..ee67dd77 --- /dev/null +++ b/docs/sqlhtml.rst @@ -0,0 +1,8 @@ + +:mod:`sqlhtml` Module +--------------------- + +.. automodule:: gluon.sqlhtml + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/storage.rst b/docs/storage.rst new file mode 100644 index 00000000..b0440470 --- /dev/null +++ b/docs/storage.rst @@ -0,0 +1,8 @@ + +:mod:`storage` Module +--------------------- + +.. automodule:: gluon.storage + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/streamer.rst b/docs/streamer.rst new file mode 100644 index 00000000..a9e067a4 --- /dev/null +++ b/docs/streamer.rst @@ -0,0 +1,8 @@ + +:mod:`streamer` Module +---------------------- + +.. automodule:: gluon.streamer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/template.rst b/docs/template.rst new file mode 100644 index 00000000..8b6874a5 --- /dev/null +++ b/docs/template.rst @@ -0,0 +1,8 @@ + +:mod:`template` Module +---------------------- + +.. automodule:: gluon.template + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/tools.rst b/docs/tools.rst new file mode 100644 index 00000000..97507723 --- /dev/null +++ b/docs/tools.rst @@ -0,0 +1,8 @@ + +:mod:`tools` Module +-------------------- + +.. automodule:: gluon.tools + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/utf8.rst b/docs/utf8.rst new file mode 100644 index 00000000..b16e5aae --- /dev/null +++ b/docs/utf8.rst @@ -0,0 +1,8 @@ + +:mod:`utf8` Module +-------------------- + +.. automodule:: gluon.utf8 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/utils.rst b/docs/utils.rst new file mode 100644 index 00000000..b2efd4a9 --- /dev/null +++ b/docs/utils.rst @@ -0,0 +1,8 @@ + +:mod:`utils` Module +-------------------- + +.. automodule:: gluon.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/validators.rst b/docs/validators.rst new file mode 100644 index 00000000..a6303663 --- /dev/null +++ b/docs/validators.rst @@ -0,0 +1,8 @@ + +:mod:`validators` Module +------------------------ + +.. automodule:: gluon.validators + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/widget.rst b/docs/widget.rst new file mode 100644 index 00000000..4d9a7b80 --- /dev/null +++ b/docs/widget.rst @@ -0,0 +1,8 @@ + +:mod:`widget` Module +-------------------- + +.. automodule:: gluon.widget + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/xmlrpc.rst b/docs/xmlrpc.rst new file mode 100644 index 00000000..cef3d365 --- /dev/null +++ b/docs/xmlrpc.rst @@ -0,0 +1,9 @@ + +:mod:`xmlrpc` Module +-------------------- + +.. automodule:: gluon.xmlrpc + :members: + :undoc-members: + :show-inheritance: +