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