Merge 4e1a6eb into 5cb1edf

environmentalscience · Jun 26, 2017 · 63164d6 · 63164d6
2 parents 5cb1edf + 4e1a6eb
commit 63164d6
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 8 deletions.
diff --git a/docs/authors.rst b/docs/authors.rst
@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -69,7 +69,7 @@ def process_base(app, objtype, membername, member, skip, options):
 
 def setup(app):
     app.connect('autodoc-skip-member', process_base)
-    app.add_autodocumenter(BaseDocumenter)
+    AutoDirective._registry['base_expression'] = BaseDocumenter
 
     def get_attr(obj, value, *args, **kwargs):
         return getattr(obj.definition, value)
@@ -84,6 +84,9 @@ def get_attr(obj, value, *args, **kwargs):
 #
 # needs_sphinx = '1.0'
 
+# Do not warn on external images.
+suppress_warnings = ['image.nonlocal_uri', 'ref.citation']
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
@@ -162,13 +165,35 @@ def get_attr(obj, value, *args, **kwargs):
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    'description': 'This package contains helpers to deal with physical variables '
+                   'and units in SageMath.',
+    'github_user': 'environmentalscience',
+    'github_repo': 'essm',
+    'github_button': False,
+    'github_banner': True,
+    'show_powered_by': False,
+    'extra_nav_links': {
+        'essm@GitHub': 'https://github.com/environmentalscience/essm',
+        'essm@PyPI': 'https://pypi.python.org/pypi/essm/',
+    }
+}
 
 # 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']
-
+# html_static_path = ['_static']
+
+# Custom sidebar templates, maps document names to template names.
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
 
 # -- Options for HTMLHelp output ------------------------------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -33,12 +33,13 @@ interested.
    :maxdepth: 1
 
    license
-   ../AUTHORS
+   authors
 
 References
 ==========
 
 .. bibliography:: refs.bib
+   :cited:
 
 Indices and tables
 ==================

diff --git a/docs/refs.bib b/docs/refs.bib
@@ -17,8 +17,6 @@ @Book{monteith_principles_2007
   ISBN                     = {0-12-505103-4}
 }
 
-}
-
 @Article{schymanski_leaf-scale_2017,
   Title                    = {Leaf-scale experiments reveal an important omission in the {Penman}{\textendash}{Monteith} equation},
   Author                   = {Schymanski, S. J. and Or, D.},

diff --git a/essm/equations/chamber/insulation.py b/essm/equations/chamber/insulation.py
@@ -28,7 +28,7 @@
 class eq_Qi(Equation):
     """Calculate ....
 
-    :cite:`schymanski_leaf-scale_2016`
+    :cite:`schymanski_leaf-scale_2017`
     """
 
     expr = Q_i == dT_i * lambda_i * A_i / L_i

diff --git a/setup.cfg b/setup.cfg
@@ -2,6 +2,8 @@
 test = pytest
 
 [build_sphinx]
+# Set warning-is-error = false if you want to force building documentation
+warning-is-error = true
 source-dir = docs/
 build-dir = docs/_build
 all_files = 1