Download as
Browse Code »

Commit 546cdff224b8c3cb6fdd070bdb5b7329df602d22

Authored by Sergio Oliveira
1 parent 197b2837
Exists in master and in 39 other branches 1.12.x, add_requests_as_dep, celery_service, change-passwd-signal, check-port, colab-signals, colab-vcard, colab_search, colab_tag, colab_tag_merge, community_association, detach_super_archives, fix-dashboard, fix-message-preview, fix_app_label, fix_cache_count_spb, fix_header, fixed_gitlab_import, go_to_profile_panel, header_footer, layout-fix, mobile_user_scalable, move_out_plugins, paginate-threads, profile_integration, refactor-data-import, remove-gitlab-plugin, removing_namespace, search_block, search_filters, spb-release/3.0, split_screen, stable, startplugin, timestamp_plugins, translation_review, user_regex, validate-passwd, workin_whoosh_temp

Added base docs

Showing 3 changed files with 534 additions and 0 deletions   Show diff stats
docs/Makefile 0 → 100644
  Diff comments   View file @546cdff
... ... @@ -0,0 +1,177 @@
  1 +# Makefile for Sphinx documentation
  2 +#
  3 +
  4 +# You can set these variables from the command line.
  5 +SPHINXOPTS =
  6 +SPHINXBUILD = sphinx-build
  7 +PAPER =
  8 +BUILDDIR = build
  9 +
  10 +# User-friendly check for sphinx-build
  11 +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
  12 +$(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/)
  13 +endif
  14 +
  15 +# Internal variables.
  16 +PAPEROPT_a4 = -D latex_paper_size=a4
  17 +PAPEROPT_letter = -D latex_paper_size=letter
  18 +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  19 +# the i18n builder cannot share the environment and doctrees with the others
  20 +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  21 +
  22 +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
  23 +
  24 +help:
  25 + @echo "Please use \`make <target>' where <target> is one of"
  26 + @echo " html to make standalone HTML files"
  27 + @echo " dirhtml to make HTML files named index.html in directories"
  28 + @echo " singlehtml to make a single large HTML file"
  29 + @echo " pickle to make pickle files"
  30 + @echo " json to make JSON files"
  31 + @echo " htmlhelp to make HTML files and a HTML help project"
  32 + @echo " qthelp to make HTML files and a qthelp project"
  33 + @echo " devhelp to make HTML files and a Devhelp project"
  34 + @echo " epub to make an epub"
  35 + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  36 + @echo " latexpdf to make LaTeX files and run them through pdflatex"
  37 + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
  38 + @echo " text to make text files"
  39 + @echo " man to make manual pages"
  40 + @echo " texinfo to make Texinfo files"
  41 + @echo " info to make Texinfo files and run them through makeinfo"
  42 + @echo " gettext to make PO message catalogs"
  43 + @echo " changes to make an overview of all changed/added/deprecated items"
  44 + @echo " xml to make Docutils-native XML files"
  45 + @echo " pseudoxml to make pseudoxml-XML files for display purposes"
  46 + @echo " linkcheck to check all external links for integrity"
  47 + @echo " doctest to run all doctests embedded in the documentation (if enabled)"
  48 +
  49 +clean:
  50 + rm -rf $(BUILDDIR)/*
  51 +
  52 +html:
  53 + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  54 + @echo
  55 + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  56 +
  57 +dirhtml:
  58 + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  59 + @echo
  60 + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  61 +
  62 +singlehtml:
  63 + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  64 + @echo
  65 + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  66 +
  67 +pickle:
  68 + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  69 + @echo
  70 + @echo "Build finished; now you can process the pickle files."
  71 +
  72 +json:
  73 + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  74 + @echo
  75 + @echo "Build finished; now you can process the JSON files."
  76 +
  77 +htmlhelp:
  78 + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  79 + @echo
  80 + @echo "Build finished; now you can run HTML Help Workshop with the" \
  81 + ".hhp project file in $(BUILDDIR)/htmlhelp."
  82 +
  83 +qthelp:
  84 + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  85 + @echo
  86 + @echo "Build finished; now you can run "qcollectiongenerator" with the" \
  87 + ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  88 + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/colab.qhcp"
  89 + @echo "To view the help file:"
  90 + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/colab.qhc"
  91 +
  92 +devhelp:
  93 + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  94 + @echo
  95 + @echo "Build finished."
  96 + @echo "To view the help file:"
  97 + @echo "# mkdir -p $$HOME/.local/share/devhelp/colab"
  98 + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/colab"
  99 + @echo "# devhelp"
  100 +
  101 +epub:
  102 + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  103 + @echo
  104 + @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  105 +
  106 +latex:
  107 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  108 + @echo
  109 + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  110 + @echo "Run \`make' in that directory to run these through (pdf)latex" \
  111 + "(use \`make latexpdf' here to do that automatically)."
  112 +
  113 +latexpdf:
  114 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  115 + @echo "Running LaTeX files through pdflatex..."
  116 + $(MAKE) -C $(BUILDDIR)/latex all-pdf
  117 + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  118 +
  119 +latexpdfja:
  120 + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  121 + @echo "Running LaTeX files through platex and dvipdfmx..."
  122 + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
  123 + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  124 +
  125 +text:
  126 + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  127 + @echo
  128 + @echo "Build finished. The text files are in $(BUILDDIR)/text."
  129 +
  130 +man:
  131 + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  132 + @echo
  133 + @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  134 +
  135 +texinfo:
  136 + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  137 + @echo
  138 + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  139 + @echo "Run \`make' in that directory to run these through makeinfo" \
  140 + "(use \`make info' here to do that automatically)."
  141 +
  142 +info:
  143 + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  144 + @echo "Running Texinfo files through makeinfo..."
  145 + make -C $(BUILDDIR)/texinfo info
  146 + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
  147 +
  148 +gettext:
  149 + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  150 + @echo
  151 + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  152 +
  153 +changes:
  154 + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  155 + @echo
  156 + @echo "The overview file is in $(BUILDDIR)/changes."
  157 +
  158 +linkcheck:
  159 + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  160 + @echo
  161 + @echo "Link check complete; look for any errors in the above output " \
  162 + "or in $(BUILDDIR)/linkcheck/output.txt."
  163 +
  164 +doctest:
  165 + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  166 + @echo "Testing of doctests in the sources finished, look at the " \
  167 + "results in $(BUILDDIR)/doctest/output.txt."
  168 +
  169 +xml:
  170 + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
  171 + @echo
  172 + @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
  173 +
  174 +pseudoxml:
  175 + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
  176 + @echo
  177 + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
... ...
docs/source/conf.py 0 → 100644
  Diff comments   View file @546cdff
... ... @@ -0,0 +1,335 @@
  1 +# -*- coding: utf-8 -*-
  2 +#
  3 +# colab documentation build configuration file, created by
  4 +# sphinx-quickstart on Thu Jan 22 10:59:39 2015.
  5 +#
  6 +# This file is execfile()d with the current directory set to its
  7 +# containing dir.
  8 +#
  9 +# Note that not all possible configuration values are present in this
  10 +# autogenerated file.
  11 +#
  12 +# All configuration values have a default; values that are commented out
  13 +# serve to show the default.
  14 +
  15 +import sys
  16 +import os
  17 +
  18 +# If extensions (or modules to document with autodoc) are in another directory,
  19 +# add these directories to sys.path here. If the directory is relative to the
  20 +# documentation root, use os.path.abspath to make it absolute, like shown here.
  21 +#sys.path.insert(0, os.path.abspath('.'))
  22 +
  23 +# -- General configuration ------------------------------------------------
  24 +
  25 +# If your documentation needs a minimal Sphinx version, state it here.
  26 +#needs_sphinx = '1.0'
  27 +
  28 +# Add any Sphinx extension module names here, as strings. They can be
  29 +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  30 +# ones.
  31 +extensions = [
  32 + 'sphinx.ext.autodoc',
  33 + 'sphinx.ext.doctest',
  34 + 'sphinx.ext.todo',
  35 + 'sphinx.ext.coverage',
  36 + 'sphinx.ext.pngmath',
  37 + 'sphinx.ext.viewcode',
  38 +]
  39 +
  40 +# Add any paths that contain templates here, relative to this directory.
  41 +templates_path = ['_templates']
  42 +
  43 +# The suffix of source filenames.
  44 +source_suffix = '.rst'
  45 +
  46 +# The encoding of source files.
  47 +#source_encoding = 'utf-8-sig'
  48 +
  49 +# The master toctree document.
  50 +master_doc = 'index'
  51 +
  52 +# General information about the project.
  53 +project = u'colab'
  54 +copyright = u'2015, Sergio Oliveira'
  55 +
  56 +# The version info for the project you're documenting, acts as replacement for
  57 +# |version| and |release|, also used in various other places throughout the
  58 +# built documents.
  59 +#
  60 +# The short X.Y version.
  61 +version = '2.0'
  62 +# The full version, including alpha/beta/rc tags.
  63 +release = '2.0dev'
  64 +
  65 +# The language for content autogenerated by Sphinx. Refer to documentation
  66 +# for a list of supported languages.
  67 +#language = None
  68 +
  69 +# There are two options for replacing |today|: either, you set today to some
  70 +# non-false value, then it is used:
  71 +#today = ''
  72 +# Else, today_fmt is used as the format for a strftime call.
  73 +#today_fmt = '%B %d, %Y'
  74 +
  75 +# List of patterns, relative to source directory, that match files and
  76 +# directories to ignore when looking for source files.
  77 +exclude_patterns = []
  78 +
  79 +# The reST default role (used for this markup: `text`) to use for all
  80 +# documents.
  81 +#default_role = None
  82 +
  83 +# If true, '()' will be appended to :func: etc. cross-reference text.
  84 +#add_function_parentheses = True
  85 +
  86 +# If true, the current module name will be prepended to all description
  87 +# unit titles (such as .. function::).
  88 +#add_module_names = True
  89 +
  90 +# If true, sectionauthor and moduleauthor directives will be shown in the
  91 +# output. They are ignored by default.
  92 +#show_authors = False
  93 +
  94 +# The name of the Pygments (syntax highlighting) style to use.
  95 +pygments_style = 'sphinx'
  96 +
  97 +# A list of ignored prefixes for module index sorting.
  98 +#modindex_common_prefix = []
  99 +
  100 +# If true, keep warnings as "system message" paragraphs in the built documents.
  101 +#keep_warnings = False
  102 +
  103 +
  104 +# -- Options for HTML output ----------------------------------------------
  105 +
  106 +# The theme to use for HTML and HTML Help pages. See the documentation for
  107 +# a list of builtin themes.
  108 +html_theme = 'default'
  109 +
  110 +# Theme options are theme-specific and customize the look and feel of a theme
  111 +# further. For a list of options available for each theme, see the
  112 +# documentation.
  113 +#html_theme_options = {}
  114 +
  115 +# Add any paths that contain custom themes here, relative to this directory.
  116 +#html_theme_path = []
  117 +
  118 +# The name for this set of Sphinx documents. If None, it defaults to
  119 +# "<project> v<release> documentation".
  120 +#html_title = None
  121 +
  122 +# A shorter title for the navigation bar. Default is the same as html_title.
  123 +#html_short_title = None
  124 +
  125 +# The name of an image file (relative to this directory) to place at the top
  126 +# of the sidebar.
  127 +#html_logo = None
  128 +
  129 +# The name of an image file (within the static path) to use as favicon of the
  130 +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  131 +# pixels large.
  132 +#html_favicon = None
  133 +
  134 +# Add any paths that contain custom static files (such as style sheets) here,
  135 +# relative to this directory. They are copied after the builtin static files,
  136 +# so a file named "default.css" will overwrite the builtin "default.css".
  137 +html_static_path = ['_static']
  138 +
  139 +# Add any extra paths that contain custom files (such as robots.txt or
  140 +# .htaccess) here, relative to this directory. These files are copied
  141 +# directly to the root of the documentation.
  142 +#html_extra_path = []
  143 +
  144 +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  145 +# using the given strftime format.
  146 +#html_last_updated_fmt = '%b %d, %Y'
  147 +
  148 +# If true, SmartyPants will be used to convert quotes and dashes to
  149 +# typographically correct entities.
  150 +#html_use_smartypants = True
  151 +
  152 +# Custom sidebar templates, maps document names to template names.
  153 +#html_sidebars = {}
  154 +
  155 +# Additional templates that should be rendered to pages, maps page names to
  156 +# template names.
  157 +#html_additional_pages = {}
  158 +
  159 +# If false, no module index is generated.
  160 +#html_domain_indices = True
  161 +
  162 +# If false, no index is generated.
  163 +#html_use_index = True
  164 +
  165 +# If true, the index is split into individual pages for each letter.
  166 +#html_split_index = False
  167 +
  168 +# If true, links to the reST sources are added to the pages.
  169 +#html_show_sourcelink = True
  170 +
  171 +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  172 +#html_show_sphinx = True
  173 +
  174 +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  175 +#html_show_copyright = True
  176 +
  177 +# If true, an OpenSearch description file will be output, and all pages will
  178 +# contain a <link> tag referring to it. The value of this option must be the
  179 +# base URL from which the finished HTML is served.
  180 +#html_use_opensearch = ''
  181 +
  182 +# This is the file name suffix for HTML files (e.g. ".xhtml").
  183 +#html_file_suffix = None
  184 +
  185 +# Output file base name for HTML help builder.
  186 +htmlhelp_basename = 'colabdoc'
  187 +
  188 +
  189 +# -- Options for LaTeX output ---------------------------------------------
  190 +
  191 +latex_elements = {
  192 +# The paper size ('letterpaper' or 'a4paper').
  193 +#'papersize': 'letterpaper',
  194 +
  195 +# The font size ('10pt', '11pt' or '12pt').
  196 +#'pointsize': '10pt',
  197 +
  198 +# Additional stuff for the LaTeX preamble.
  199 +#'preamble': '',
  200 +}
  201 +
  202 +# Grouping the document tree into LaTeX files. List of tuples
  203 +# (source start file, target name, title,
  204 +# author, documentclass [howto, manual, or own class]).
  205 +latex_documents = [
  206 + ('index', 'colab.tex', u'colab Documentation',
  207 + u'Sergio Oliveira', 'manual'),
  208 +]
  209 +
  210 +# The name of an image file (relative to this directory) to place at the top of
  211 +# the title page.
  212 +#latex_logo = None
  213 +
  214 +# For "manual" documents, if this is true, then toplevel headings are parts,
  215 +# not chapters.
  216 +#latex_use_parts = False
  217 +
  218 +# If true, show page references after internal links.
  219 +#latex_show_pagerefs = False
  220 +
  221 +# If true, show URL addresses after external links.
  222 +#latex_show_urls = False
  223 +
  224 +# Documents to append as an appendix to all manuals.
  225 +#latex_appendices = []
  226 +
  227 +# If false, no module index is generated.
  228 +#latex_domain_indices = True
  229 +
  230 +
  231 +# -- Options for manual page output ---------------------------------------
  232 +
  233 +# One entry per manual page. List of tuples
  234 +# (source start file, name, description, authors, manual section).
  235 +man_pages = [
  236 + ('index', 'colab', u'colab Documentation',
  237 + [u'Sergio Oliveira'], 1)
  238 +]
  239 +
  240 +# If true, show URL addresses after external links.
  241 +#man_show_urls = False
  242 +
  243 +
  244 +# -- Options for Texinfo output -------------------------------------------
  245 +
  246 +# Grouping the document tree into Texinfo files. List of tuples
  247 +# (source start file, target name, title, author,
  248 +# dir menu entry, description, category)
  249 +texinfo_documents = [
  250 + ('index', 'colab', u'colab Documentation',
  251 + u'Sergio Oliveira', 'colab', 'One line description of project.',
  252 + 'Miscellaneous'),
  253 +]
  254 +
  255 +# Documents to append as an appendix to all manuals.
  256 +#texinfo_appendices = []
  257 +
  258 +# If false, no module index is generated.
  259 +#texinfo_domain_indices = True
  260 +
  261 +# How to display URL addresses: 'footnote', 'no', or 'inline'.
  262 +#texinfo_show_urls = 'footnote'
  263 +
  264 +# If true, do not generate a @detailmenu in the "Top" node's menu.
  265 +#texinfo_no_detailmenu = False
  266 +
  267 +
  268 +# -- Options for Epub output ----------------------------------------------
  269 +
  270 +# Bibliographic Dublin Core info.
  271 +epub_title = u'colab'
  272 +epub_author = u'Sergio Oliveira'
  273 +epub_publisher = u'Sergio Oliveira'
  274 +epub_copyright = u'2015, Sergio Oliveira'
  275 +
  276 +# The basename for the epub file. It defaults to the project name.
  277 +#epub_basename = u'colab'
  278 +
  279 +# The HTML theme for the epub output. Since the default themes are not optimized
  280 +# for small screen space, using the same theme for HTML and epub output is
  281 +# usually not wise. This defaults to 'epub', a theme designed to save visual
  282 +# space.
  283 +#epub_theme = 'epub'
  284 +
  285 +# The language of the text. It defaults to the language option
  286 +# or en if the language is not set.
  287 +#epub_language = ''
  288 +
  289 +# The scheme of the identifier. Typical schemes are ISBN or URL.
  290 +#epub_scheme = ''
  291 +
  292 +# The unique identifier of the text. This can be a ISBN number
  293 +# or the project homepage.
  294 +#epub_identifier = ''
  295 +
  296 +# A unique identification for the text.
  297 +#epub_uid = ''
  298 +
  299 +# A tuple containing the cover image and cover page html template filenames.
  300 +#epub_cover = ()
  301 +
  302 +# A sequence of (type, uri, title) tuples for the guide element of content.opf.
  303 +#epub_guide = ()
  304 +
  305 +# HTML files that should be inserted before the pages created by sphinx.
  306 +# The format is a list of tuples containing the path and title.
  307 +#epub_pre_files = []
  308 +
  309 +# HTML files shat should be inserted after the pages created by sphinx.
  310 +# The format is a list of tuples containing the path and title.
  311 +#epub_post_files = []
  312 +
  313 +# A list of files that should not be packed into the epub file.
  314 +epub_exclude_files = ['search.html']
  315 +
  316 +# The depth of the table of contents in toc.ncx.
  317 +#epub_tocdepth = 3
  318 +
  319 +# Allow duplicate toc entries.
  320 +#epub_tocdup = True
  321 +
  322 +# Choose between 'default' and 'includehidden'.
  323 +#epub_tocscope = 'default'
  324 +
  325 +# Fix unsupported image types using the PIL.
  326 +#epub_fix_images = False
  327 +
  328 +# Scale large images.
  329 +#epub_max_image_width = 0
  330 +
  331 +# How to display URL addresses: 'footnote', 'no', or 'inline'.
  332 +#epub_show_urls = 'inline'
  333 +
  334 +# If false, no index is generated.
  335 +#epub_use_index = True
... ...
docs/source/index.rst 0 → 100644
  Diff comments   View file @546cdff
... ... @@ -0,0 +1,22 @@
  1 +.. colab documentation master file, created by
  2 + sphinx-quickstart on Thu Jan 22 10:59:39 2015.
  3 + You can adapt this file completely to your liking, but it should at least
  4 + contain the root `toctree` directive.
  5 +
  6 +Welcome to colab's documentation!
  7 +=================================
  8 +
  9 +Contents:
  10 +
  11 +.. toctree::
  12 + :maxdepth: 2
  13 +
  14 +
  15 +
  16 +Indices and tables
  17 +==================
  18 +
  19 +* :ref:`genindex`
  20 +* :ref:`modindex`
  21 +* :ref:`search`
  22 +
... ...