First major EMPyRe commit!

Added the fields submodule with field, shapes and vectors!
Added the vis module (not viz) with colors, decorators, plot2d, tools.
Added version.
Minor changes in pyramid.

.gitignore

@@ -8,5 +8,6 @@ desktop.ini
 *.DS
 *.ipynb_checkpoints*
 build/*
-docs/api/*
+docs/_build/*
 dist/*
+src/empyre/version.py

.gitlab-ci.yml

 before_script:
-    # Install requirements for pyramid:
+    # Install requirements for empyre:
     - conda env create -q # -q: quiet/ no progressbar, because it spams the log!
-    - source activate pyramid
+    - conda init bash
+    - source ~/.bashrc
+    - conda activate empyre
     - conda info --envs
-    # Install jutil via deploy token access:
-    - pip install git+https://pyramid:"$JUTIL_DEPLOY_TOKEN"@jugit.fz-juelich.de/j.ungermann/jutil.git
+    # Install jutil via deploy token access:  # TODO: still needed?
+    #- pip install git+https://empyre:"$JUTIL_DEPLOY_TOKEN"@jugit.fz-juelich.de/j.ungermann/jutil.git
 
 stages:
     - test
-    - deploy  # TODO: add stage later, upload docs, coverage and such, shift artifacts here?
+    - deploy
 
 test_style:
-    image: continuumio/miniconda3:latest
     stage: test
+    image: continuumio/miniconda3:latest
     script:
         # -m: only run tests marked with "flake8"
+        - pyroma .  # Checks setup.py for cheese!
         - python setup.py test --addopts "--flake8 -m flake8"
 
 test_function:
-    image: continuumio/miniconda3:latest
     stage: test
+    image: continuumio/miniconda3:latest
+    script:
+        # Execute all tests and also check coverage with --cov:
+        - python setup.py test --addopts "--cov"
     artifacts:
         paths:
             - .coverage
         expire_in: 1 week
-    script:
-        # Execute all tests and also check coverage with --cov:
-        - python setup.py test --addopts "--cov"
 
 test_docs:
-    image: continuumio/miniconda3:latest
     stage: test
+    image: continuumio/miniconda3:latest
     script:
-    # -f: Force overwriting of any existing generated files.
-    # -e: Put documentation for each module on its own page.
-    # -o: Directory to place the output files. If it does not exist, it is created.
-    # last parameter: module path
-    - sphinx-apidoc -f -e -o docs/api pyramid
-    # Build the documentation from 'docs' and put into 'build/sphinx':
-    - sphinx-build docs build/sphinx
+        # -f: Force overwriting of any existing generated files.
+        # -e: Put documentation for each module on its own page.
+        # -o: Directory to place the output files. If it does not exist, it is created.
+        # last parameter: module path
+        - sphinx-apidoc -f -e -o docs/api src/empyre
+        # Build the documentation from 'docs' and put into 'build/sphinx':
+        - sphinx-build docs build/sphinx
     artifacts:
         paths:
             - build/sphinx
         expire_in: 1 week
+
+pages:
+    stage: deploy
+    image: busybox
+    before_script: []  # before_script not needed here!
+    script:
+        - mkdir public
+        - cp -r build/sphinx/* public/
+        # -r: recursive, also copies subfolders!
+    artifacts:
+        paths:
+            - public
+    only:  # Will be deprecated in the future, should then be replaced with rules (see pypi job)!
+       - master
+
+pypi:
+    stage: deploy
+    image: continuumio/miniconda3:latest
+    before_script: []
+    script:
+        - pip install twine
+        - python setup.py sdist bdist_wheel
+        - twine upload -u __token__ -p $PYPI_ACCESS_TOKEN dist/*
+    rules:  # similar to only/except, but newer!
+        # Job is executed if branch is master AND if a tag is building which matches the regular expression!
+        # ONLY executes if commit to master has a tag, ^:start, $:end, valid example: "1.2.3", no "-dev" at the end!
+        - if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "master" && $CI_COMMIT_TAG =~ /^\d+\.\d+(\.\d+)?$/'

.gitlab/issue_templates/bug.md

+<!--
+Please read this!
+
+Before opening a new issue, make sure to search for keywords in the issues
+filtered by the "bug" label:
+
+- https://jugit.fz-juelich.de/j.caron/empyre/issues?label_name%5B%5D=bug
+
+and verify the issue you're about to submit isn't a duplicate.
+-->
+
+### Summary
+
+<!-- Summarize the bug encountered concisely. -->
+
+### Steps to reproduce
+
+<!-- How one can reproduce the issue - this is very important. -->
+
+### What is the current *bug* behavior?
+
+<!-- What actually happens. -->
+
+### What is the expected *correct* behavior?
+
+<!-- What you should see instead. -->
+
+### Relevant logs and/or screenshots
+
+<!-- Paste any relevant logs - please use code blocks (```) to format console output,
+logs, and code as it's tough to read otherwise.. -->
+
+### Possible fixes
+
+<!-- If you can, link to the line of code that might be responsible for the problem. -->
+
+~bug
\ No newline at end of file

.gitlab/issue_templates/feature request.md

+### Problem to solve
+
+<!-- What problem do we solve? -->
+
+### Intended users
+
+<!-- Who will use this feature? . It's okay to write "Unknown" and fill this field in later. -->
+
+### Further details
+
+<!-- Include use cases, benefits, and/or goals -->
+
+### Proposal
+
+<!-- How are we going to solve the problem? -->
+
+### Documentation
+
+<!-- Add all known Documentation Requirements here. -->
+
+~feature
\ No newline at end of file

LICENSE

@@ -631,8 +631,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    pyramid
-    Copyright (C) 2018  Jan Caron
+    empyre
+    Copyright (C) 2020  Jan Caron
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    pyramid  Copyright (C) 2018  Jan Caron
+    empyre  Copyright (C) 2020  Jan Caron
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

README.rst

+The documentation can be found [here](https://empyre.iffgit.fz-juelich.de/empyre/)!

docs/.static/sphinxdoc.css

-/*
- * sphinxdoc.css_t
- * ~~~~~~~~~~~~~~~
- *
- * Sphinx stylesheet -- sphinxdoc theme.  Originally created by
- * Armin Ronacher for Werkzeug.
- *
- * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
- */
-
-@import url("basic.css");
-
-/* -- page layout ----------------------------------------------------------- */
-
-body {
-    font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
-                 'Verdana', sans-serif;
-    font-size: 14px;
-    letter-spacing: -0.01em;
-    line-height: 150%;
-    text-align: center;
-    background-color: #BFD1D4;
-    color: black;
-    padding: 0;
-    border: 1px solid #aaa;
-
-    margin: 0px 80px 0px 80px;
-    min-width: 740px;
-}
-
-div.document {
-    background-color: white;
-    text-align: left;
-    background-image: url(contents.png);
-    background-repeat: repeat-x;
-}
-
-div.bodywrapper {
-    margin: 0 240px 0 0;
-    border-right: 1px solid #ccc;
-}
-
-div.body {
-    margin: 0;
-    padding: 0.5em 20px 20px 20px;
-}
-
-div.related {
-    font-size: 1em;
-}
-
-div.related ul {
-    background-image: url(navigation.png);
-    height: 2em;
-    border-top: 1px solid #ddd;
-    border-bottom: 1px solid #ddd;
-}
-
-div.related ul li {
-    margin: 0;
-    padding: 0;
-    height: 2em;
-    float: left;
-}
-
-div.related ul li.right {
-    float: right;
-    margin-right: 5px;
-}
-
-div.related ul li a {
-    margin: 0;
-    padding: 0 5px 0 5px;
-    line-height: 1.75em;
-    color: #EE9816;
-}
-
-div.related ul li a:hover {
-    color: #3CA8E7;
-}
-
-div.sphinxsidebarwrapper {
-    padding: 0;
-}
-
-div.sphinxsidebar {
-    margin: 0;
-    padding: 0.5em 15px 15px 0;
-    width: 210px;
-    float: right;
-    font-size: 1em;
-    text-align: left;
-}
-
-div.sphinxsidebar h3, div.sphinxsidebar h4 {
-    margin: 1em 0 0.5em 0;
-    font-size: 1em;
-    padding: 0.1em 0 0.1em 0.5em;
-    color: white;
-    border: 1px solid #86989B;
-    background-color: #AFC1C4;
-}
-
-div.sphinxsidebar h3 a {
-    color: white;
-}
-
-div.sphinxsidebar ul {
-    padding-left: 1.5em;
-    margin-top: 7px;
-    padding: 0;
-    line-height: 130%;
-}
-
-div.sphinxsidebar ul ul {
-    margin-left: 20px;
-}
-
-div.footer {
-    background-color: #E3EFF1;
-    color: #86989B;
-    padding: 3px 8px 3px 0;
-    clear: both;
-    font-size: 0.8em;
-    text-align: right;
-}
-
-div.footer a {
-    color: #86989B;
-    text-decoration: underline;
-}
-
-/* -- body styles ----------------------------------------------------------- */
-
-p {    
-    margin: 0.8em 0 0.5em 0;
-}
-
-a {
-    color: #000000; /*!!! MAKE LINKS ORANGE AGAIN:			#CA7900;*/
-    text-decoration: none;
-}
-
-a:hover {
-    color: #2491CF;
-}
-
-div.body a {
-    text-decoration: none; /*!!! UNDERLINE LINKS AGAIN:		underline;*/
-}
-
-h1 {
-    margin: 0;
-    padding: 0.7em 0 0.3em 0;
-    font-size: 1.5em;
-    color: #11557C;
-	background-color: #ccd8ff;
-}
-
-h2 {
-    margin: 1.3em 0 0.2em 0;
-    font-size: 1.35em;
-    padding: 0;
-	background-color: #ccd8ff;
-}
-
-h3 {
-    margin: 1em 0 -0.3em 0;
-    font-size: 1.2em;
-	background-color: #ccd8ff;
-}
-
-h4 {
-	background-color: #ccd8ff
-}
-
-h5 {
-	background-color: #ccd8ff
-}
-
-div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a {
-    color: black!important;
-}
-
-h1 a.anchor, h2 a.anchor, h3 a.anchor, h4 a.anchor, h5 a.anchor, h6 a.anchor {
-    display: none;
-    margin: 0 0 0 0.3em;
-    padding: 0 0.2em 0 0.2em;
-    color: #aaa!important;
-}
-
-h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor,
-h5:hover a.anchor, h6:hover a.anchor {
-    display: inline;
-}
-
-h1 a.anchor:hover, h2 a.anchor:hover, h3 a.anchor:hover, h4 a.anchor:hover,
-h5 a.anchor:hover, h6 a.anchor:hover {
-    color: #777;
-    background-color: #eee;
-}
-
-a.headerlink {
-    color: #c60f0f!important;
-    font-size: 1em;
-    margin-left: 6px;
-    padding: 0 4px 0 4px;
-    text-decoration: none!important;
-}
-
-a.headerlink:hover {
-    background-color: #ccc;
-    color: white!important;
-}
-
-cite, code, tt {
-    font-family: 'Consolas', 'Deja Vu Sans Mono',
-                 'Bitstream Vera Sans Mono', monospace;
-    font-size: 1.17em;
-    letter-spacing: 0.01em;
-}
-
-tt {
-    background-color: #f2f2f2;
-    border-bottom: 1px solid #ddd;
-    color: #333;
-}
-
-tt.descname, tt.descclassname, tt.xref {
-    border: 0;
-}
-
-hr {
-    border: 1px solid #abc;
-    margin: 2em;
-}
-
-a tt {
-    border: 0;
-    color: #CA7900;
-}
-
-a tt:hover {
-    color: #2491CF;
-}
-
-th {
-    background-color: #fff3cc;
-}
-
-pre {
-    font-family: 'Consolas', 'Deja Vu Sans Mono',
-                 'Bitstream Vera Sans Mono', monospace;
-    font-size: 0.95em;
-    letter-spacing: 0.015em;
-    line-height: 120%;
-    padding: 0.5em;
-    border: 1px solid #ccc;
-    background-color: #f8f8f8;
-}
-
-pre a {
-    color: inherit;
-    text-decoration: underline;
-}
-
-td.linenos pre {
-    padding: 0.5em 0;
-}
-
-div.quotebar {
-    background-color: #f8f8f8;
-    max-width: 250px;
-    float: right;
-    padding: 2px 7px;
-    border: 1px solid #ccc;
-}
-
-div.topic {
-    background-color: #f8f8f8;
-}
-
-table {
-    border-collapse: collapse;
-    margin: 0 -0.5em 0 -0.5em;
-}
-
-table td, table th {
-    padding: 0.2em 0.5em 0.2em 0.5em;
-}
-
-div.admonition, div.warning {
-    font-size: 0.9em;
-    margin: 1em 0 1em 0;
-    border: 1px solid #86989B;
-    background-color: #f7f7f7;
-    padding: 0;
-}
-
-div.admonition p, div.warning p {
-    margin: 0.5em 1em 0.5em 1em;
-    padding: 0;
-}
-
-div.admonition pre, div.warning pre {
-    margin: 0.4em 1em 0.4em 1em;
-}
-
-div.admonition p.admonition-title,
-div.warning p.admonition-title {
-    margin: 0;
-    padding: 0.1em 0 0.1em 0.5em;
-    color: white;
-    border-bottom: 1px solid #86989B;
-    font-weight: bold;
-    background-color: #AFC1C4;
-}
-
-div.warning {
-    border: 1px solid #940000;
-}
-
-div.warning p.admonition-title {
-    background-color: #CF0000;
-    border-bottom-color: #940000;
-}
-
-div.admonition ul, div.admonition ol,
-div.warning ul, div.warning ol {
-    margin: 0.1em 0.5em 0.5em 3em;
-    padding: 0;
-}
-
-div.versioninfo {
-    margin: 1em 0 0 0;
-    border: 1px solid #ccc;
-    background-color: #DDEAF0;
-    padding: 8px;
-    line-height: 1.3em;
-    font-size: 0.9em;
-}
-
-.viewcode-back {
-    font-family: 'Lucida Grande', 'Lucida Sans Unicode', 'Geneva',
-                 'Verdana', sans-serif;
-}
-
-div.viewcode-block:target {
-    background-color: #f4debf;
-    border-top: 1px solid #ac9;
-    border-bottom: 1px solid #ac9;
-}
\ No newline at end of file

docs/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api/empyre.fields.rst

+empyre.fields package
+=====================
+
+Submodules
+----------
+
+empyre.fields.field module
+--------------------------
+
+.. automodule:: empyre.fields.field
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+empyre.fields.shapes module
+---------------------------
+
+.. automodule:: empyre.fields.shapes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+empyre.fields.vectors module
+----------------------------
+
+.. automodule:: empyre.fields.vectors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: empyre.fields
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/empyre.io.rst

+empyre.io package
+=================
+
+Module contents
+---------------
+
+.. automodule:: empyre.io
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/empyre.models.rst

+empyre.models package
+=====================
+
+Module contents
+---------------
+
+.. automodule:: empyre.models
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/empyre.reconstruct.rst

+empyre.reconstruct package
+==========================
+
+Module contents
+---------------
+
+.. automodule:: empyre.reconstruct
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/empyre.rst

+empyre package
+==============
+
+Subpackages
+-----------
+
+.. toctree::
+
+   empyre.fields
+   empyre.io
+   empyre.models
+   empyre.reconstruct
+   empyre.vis
+
+Submodules
+----------
+
+empyre.version module
+---------------------
+
+.. automodule:: empyre.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: empyre
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/empyre.vis.rst

+empyre.vis package
+==================
+
+Submodules
+----------
+
+empyre.vis.colors module
+------------------------
+
+.. automodule:: empyre.vis.colors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+empyre.vis.decorators module
+----------------------------
+
+.. automodule:: empyre.vis.decorators
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+empyre.vis.plot2d module
+------------------------
+
+.. automodule:: empyre.vis.plot2d
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+empyre.vis.tools module
+-----------------------
+
+.. automodule:: empyre.vis.tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: empyre.vis
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/modules.rst

+empyre
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   empyre

docs/conf.py

-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
+# Configuration file for the Sphinx documentation builder.
 #
-# Pyramid documentation build configuration file, created by
-# sphinx-quickstart on Mon Feb  6 10:57:49 2017.
-#
-# 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.
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+
+# Use command in docs to generate stubs and make html afterwards:
+# > sphinx-apidoc -o api ../src/empyre
+# > make html
+
+
+# -- Path setup --------------------------------------------------------------
 
 # 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
@@ -19,13 +18,17 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(os.path.join('..', 'src')))
 
-# -- General configuration ------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
+# -- Project information -----------------------------------------------------
+
+project = 'EMPyRe'
+copyright = '2020, Jan Caron'
+author = 'Jan Caron'
+
+
+# -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -34,492 +37,43 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
-    'sphinx.ext.autosummary',
     'numpydoc'
 ]
 
 numpydoc_show_class_members = False
+add_module_names = False
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['.templates']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-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 = 'Pyramid'
-copyright = '2017, Jan Caron'
-author = 'Jan Caron'
-
-# 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 = '0.1'
-# The full version, including alpha/beta/rc tags.
-release = '0.1'
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-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'
+templates_path = ['_templates']
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['.build', 'Thumbs.db', '.DS_Store']
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-# 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
+# -- Options for HTML output -------------------------------------------------
 
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#
-# add_module_names = True
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinx_rtd_theme'
 
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#
-# show_authors = False
+# 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']
 
 # 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
-
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'sphinxdoc'
-
-# 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 = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-# html_theme_path = []
-
-# The name for this set of Sphinx documents.
-# "<project> v<release> documentation" by default.
-#
-# html_title = 'Pyramid v0.1'
-
-# 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 = 'Pyramid Logo.png'
+html_logo = 'EMPyRe Logo.png'
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the doc.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#
 html_favicon = 'icon.ico'
-
-# 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']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-#
-# html_extra_path = []
-
-# If not None, a 'Last updated on:' timestamp is inserted at every page
-# bottom, using the given strftime format.
-# The empty string is equivalent to '%b %d, %Y'.
-#
-# html_last_updated_fmt = None
-
-# 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 = True
-
-# 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 <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 = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = None
-
-# Language to be used for generating the HTML full-text search index.
-# Sphinx supports the following languages:
-#   'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja'
-#   'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh'
-#
-# html_search_language = 'en'
-
-# A dictionary with options for the search language support, empty by default.
-# 'ja' uses this config value.
-# 'zh' user can custom change `jieba` dictionary path.
-#
-# html_search_options = {'type': 'default'}
-
-# The name of a javascript file (relative to the configuration directory) that
-# implements a search results scorer. If empty, the default will be used.
-#
-# html_search_scorer = 'scorer.js'
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'Pyramiddoc'
-
-# -- 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': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, 'Pyramid.tex', 'Pyramid Documentation',
-     'Jan Caron', '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 = []
-
-# It false, will not define \strong, \code, 	itleref, \crossref ... but only
-# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
-# packages.
-#
-# latex_keep_old_macro_names = True
-
-# 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 = [(master_doc, 'pyramid', 'Pyramid Documentation', [author], 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 = [
-    (master_doc, 'Pyramid', 'Pyramid Documentation',
-     author, 'Pyramid', 'One line description of project.',
-     '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
-
-
-# -- Options for Epub output ----------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-epub_author = author
-epub_publisher = author
-epub_copyright = copyright
-
-# The basename for the epub file. It defaults to the project name.
-# epub_basename = project
-
-# The HTML theme for the epub output. Since the default themes are not
-# optimized for small screen space, using the same theme for HTML and epub
-# output is usually not wise. This defaults to 'epub', a theme designed to save
-# visual space.
-#
-# epub_theme = 'epub'
-
-# The language of the text. It defaults to the language option
-# or 'en' if the language is not set.
-#
-# epub_language = ''
-
-# The scheme of the identifier. Typical schemes are ISBN or URL.
-# epub_scheme = ''
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#
-# epub_identifier = ''
-
-# A unique identification for the text.
-#
-# epub_uid = ''
-
-# A tuple containing the cover image and cover page html template filenames.
-#
-# epub_cover = ()
-
-# A sequence of (type, uri, title) tuples for the guide element of content.opf.
-#
-# epub_guide = ()
-
-# HTML files that should be inserted before the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#
-# epub_pre_files = []
-
-# HTML files that should be inserted after the pages created by sphinx.
-# The format is a list of tuples containing the path and title.
-#
-# epub_post_files = []
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ['search.html']
-
-# The depth of the table of contents in toc.ncx.
-#
-# epub_tocdepth = 3
-
-# Allow duplicate toc entries.
-#
-# epub_tocdup = True
-
-# Choose between 'default' and 'includehidden'.
-#
-# epub_tocscope = 'default'
-
-# Fix unsupported image types using the Pillow.
-#
-# epub_fix_images = False
-
-# Scale large images.
-#
-# epub_max_image_width = 0
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#
-# epub_show_urls = 'inline'
-
-# If false, no index is generated.
-#
-# epub_use_index = True
-
-
-# -- Options for PDF output --------------------------------------------------
-# Grouping the document tree into PDF files. List of tuples
-# (source start file, target name, title, author, options).
-#
-# If there is more than one author, separate them with \\.
-# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
-#
-# The options element is a dictionary that lets you override
-# this config per-document.
-# For example,
-# ('index', u'MyProject', u'My Project', u'Author Name',
-# dict(pdf_compressed = True))
-# would mean that specific document would be compressed
-# regardless of the global pdf_compressed setting.
-
-pdf_documents = [('index', u'Pyramid', u'Pyramid', u'Jan Caron')]
-
-# A comma-separated list of custom stylesheets. Example:
-pdf_stylesheets = ['sphinx', 'kerning', 'a4']
-
-# A list of folders to search for stylesheets. Example:
-pdf_style_path = ['.', '_styles']
-
-# Create a compressed PDF
-# Use True/False or 1/0
-# Example: compressed=True
-# pdf_compressed = False
-
-# A colon-separated list of folders to search for fonts. Example:
-# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
-
-# Language to be used for hyphenation support
-# pdf_language = "en_US"
-
-# Mode for literal blocks wider than the frame. Can be
-# overflow, shrink or truncate
-# pdf_fit_mode = "shrink"
-
-# Section level that forces a break page.
-# For example: 1 means top-level sections start in a new page
-# 0 means disabled
-# pdf_break_level = 0
-
-# When a section starts in a new page, force it to be 'even', 'odd',
-# or just use 'any'
-# pdf_breakside = 'any'
-
-# Insert footnotes where they are defined instead of
-# at the end.
-# pdf_inline_footnotes = True
-
-# verbosity level. 0 1 or 2
-# pdf_verbosity = 0
-
-# If false, no index is generated.
-# pdf_use_index = True
-
-# If false, no modindex is generated.
-# pdf_use_modindex = True
-
-# If false, no coverpage is generated.
-# pdf_use_coverpage = True
-
-# Name of the cover page template to use
-# pdf_cover_template = 'sphinxcover.tmpl'
-
-# Documents to append as an appendix to all manuals.
-# pdf_appendices = []
-
-# Enable experimental feature to split table cells. Use it
-# if you get "DelayedTable too big" errors
-# pdf_splittables = False
-
-# Set the default DPI for images
-# pdf_default_dpi = 72
-
-# Enable rst2pdf extension modules (default is only vectorpdf)
-# you need vectorpdf if you want to use sphinx's graphviz support
-# pdf_extensions = ['vectorpdf']
-
-# Page template name for "regular" pages
-# pdf_page_template = 'cutePage'
-
-# Show Table Of Contents at the beginning?
-# pdf_use_toc = True
-
-# How many levels deep should the table of contents be?
-pdf_toc_depth = 9999
-
-# Add section number to section references
-pdf_use_numbered_links = False
-
-# Background images fitting mode
-pdf_fit_background_mode = 'scale'