Merge apidocs fixes into master

oemof · Mar 5, 2019 · 18b3c2f · 18b3c2f
2 parents b47ef13 + 87e497f
commit 18b3c2f
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 23 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -40,6 +40,8 @@
 if not on_rtd:  # only set the theme if we're building docs locally
     html_theme = 'sphinx_rtd_theme'
 
+html_theme_options = { "collapse_navigation": False, }
+
 html_use_smartypants = True
 html_last_updated_fmt = '%b %d, %Y'
 html_split_index = False

diff --git a/docs/reference/oemof.tabular.datapackage.rst b/docs/reference/oemof.tabular.datapackage.rst
@@ -1,6 +1,11 @@
 oemof.tabular.datapackage package
 =================================
 
+.. automodule:: oemof.tabular.datapackage
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 Submodules
 ----------
 
@@ -37,10 +42,3 @@ oemof.tabular.datapackage.reading module
     :show-inheritance:
 
 
-Module contents
----------------
-
-.. automodule:: oemof.tabular.datapackage
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/reference/oemof.tabular.rst b/docs/reference/oemof.tabular.rst
@@ -1,9 +1,28 @@
-oemof.tabular
-=============
+oemof.tabular package
+=====================
 
-.. testsetup::
+.. automodule:: oemof.tabular
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-    from oemof.tabular import *
+Subpackages
+-----------
 
-.. automodule:: oemof.tabular
+.. toctree::
+
+    oemof.tabular.datapackage
+    oemof.tabular.tools
+
+Submodules
+----------
+
+oemof.tabular.facades module
+----------------------------
+
+.. automodule:: oemof.tabular.facades
     :members:
+    :undoc-members:
+    :show-inheritance:
+
+
diff --git a/docs/reference/oemof.tabular.tools.rst b/docs/reference/oemof.tabular.tools.rst
@@ -1,6 +1,11 @@
 oemof.tabular.tools package
 ===========================
 
+.. automodule:: oemof.tabular.tools
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 Submodules
 ----------
 
@@ -13,10 +18,3 @@ oemof.tabular.tools.geometry module
     :show-inheritance:
 
 
-Module contents
----------------
-
-.. automodule:: oemof.tabular.tools
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,5 +2,3 @@ sphinx>=1.3
 sphinx-rtd-theme
 -e .
 
-git+https://git@github.com/oemof/oemof.git@features/move-datapackage-reader-into-standalone-package#egg=oemof-0.2.4.dev0
-
diff --git a/src/oemof/tabular/tools/__init__.py b/src/oemof/tabular/tools/__init__.py
@@ -38,8 +38,8 @@ def remap(mapping, renamings, selection):
     If key doesn't have a renaming, it's returned as is. If `selection` doesn't
     appear as a key in `renamings`, `mapping` is returned unchanged.
 
-    Example:
-    --------
+    Example
+    -------
     >>> renamings = {'R1': {'zero': 'nada'}, 'R2': {'foo': 'bar'}}
     >>> mapping = {'zero': 0, 'foo': 'foobar'}
     >>> remap(mapping, renamings, 'R1') == {'nada': 0, 'foo': 'foobar'}