Sets the table for better docs

samuelduchesne · Jul 12, 2019 · d359470 · d359470
1 parent e6cc25a
commit d359470
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 75 deletions.
diff --git a/.gitignore b/.gitignore
@@ -99,3 +99,5 @@ tests/\.temp/
 
 tests/input_data/schedules/eprun/
 trnsidf.exe
+
+docs/reference/
diff --git a/docs/conf.py b/docs/conf.py
@@ -16,17 +16,18 @@
 import sys
 
 sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('archetypal'))
 
 # -- Project information -----------------------------------------------------
 
 project = 'archetypal'
 copyright = '2018, Samuel Letellier-Duchesne'
 author = 'Samuel Letellier-Duchesne'
 
-# The short X.Y version
-version = ''
 # The full version, including alpha/beta/rc tags
-release = ''
+import pyTrnsysType
+
+version = release = pyTrnsysType.__version__
 
 # -- General configuration ---------------------------------------------------
 
@@ -66,6 +67,10 @@
 master_doc = 'index'
 numfig = True
 
+autosummary_generate = True
+autoclass_content = "both"
+autodoc_member_order = 'bysource'
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
@@ -75,12 +80,8 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = ['.pytest_cache', '_build', 'Thumbs.db', '.DS_Store',
-                    'README.md', 'LICENSE.md']
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -103,7 +104,6 @@
 
 def setup(app):
     app.add_stylesheet('theme_overrides.css')
-    app.connect('autodoc-skip-member', autodoc_skip_member)
     app.add_javascript('copybutton.js')
     # Add the 'copybutton' javascript, to hide/show the prompt in code examples
 
@@ -208,16 +208,3 @@ def setup(app):
 
 # If true, `_todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
-
-# -- Autodoc Skip Memebrs ____________________________________________________
-
-autodoc_default_options = {}
-
-
-def autodoc_skip_member(app, what, name, obj, skip, options):
-    exclusions = ('__weakref__',  # special-members
-                  '__doc__', '__module__', '__dict__',  # undoc-members,
-                  'archetypal.schedule._conjunction'
-                  )
-    exclude = name in exclusions
-    return skip or exclude
diff --git a/docs/converter_idf.rst b/docs/converter_idf.rst
@@ -1,5 +1,5 @@
 Convert IDF to BUI
-=====================
+==================
 
 .. figure:: images/converter@2x.png
    :alt: converter logo

diff --git a/docs/index.rst b/docs/index.rst
@@ -19,19 +19,17 @@ developed by the MIT Sustainable Design Lab.
 
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: User Guide
 
    Getting Started <first.rst>
-   Schedules <schedules.rst>
    Convert IDF to BUI <converter_idf.rst>
 
 .. toctree::
    :maxdepth: 1
    :caption: Reference Guide
 
    commands
-   Package Modules <package_modules.rst>
 
 
 Indices and tables

diff --git a/docs/modules/data_portals.rst b/docs/modules/data_portals.rst
diff --git a/docs/modules/idf.rst b/docs/modules/idf.rst
diff --git a/docs/modules/schedules.rst b/docs/modules/schedules.rst
diff --git a/docs/modules/simple_glazing_module.rst b/docs/modules/simple_glazing_module.rst
diff --git a/docs/modules/trnsys.rst b/docs/modules/trnsys.rst
diff --git a/docs/modules/utils.rst b/docs/modules/utils.rst
diff --git a/docs/package_modules.rst b/docs/package_modules.rst