Improved documentation

CenterForTheBuiltEnvironment · Feb 12, 2020 · fb76103 · fb76103
1 parent 4d12d0b
commit fb76103
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -10,10 +10,12 @@ Overview
     * - docs
       - |docs|
     * - tests
-      - | |travis| |appveyor| |requires|
-        | |codecov|
+      - | |travis| |appveyor|
+        | |codecov| |requires|
     * - package
-      - | |version| |wheel| |supported-versions| |supported-implementations|
+      - | |version| |wheel|
+        | |supported-versions|
+        | |supported-implementations|
         | |commits-since|
 .. |docs| image:: https://readthedocs.org/projects/pythermalcomfort/badge/?style=flat
     :target: https://readthedocs.org/projects/pythermalcomfort

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,7 +3,7 @@ Contents
 ========
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    readme
    installation

diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -1,5 +1,5 @@
-pythermalcomfort
-================
+Functions documentation
+=======================
 
 .. toctree::
     :glob:

diff --git a/docs/reference/pythermalcomfort.rst b/docs/reference/pythermalcomfort.rst
@@ -6,5 +6,25 @@ Comfort models
     from pythermalcomfort import *
     from pythermalcomfort.models import *
 
-.. automodule:: pythermalcomfort.models
+
+PMV
+---
+
+.. autofunction:: pythermalcomfort.models.pmv
+
+PMV PPD
+-------
+
+.. autofunction:: pythermalcomfort.models.pmv_ppd
+
+SET
+---
+
+.. autofunction:: pythermalcomfort.models.set_tmp
+
+
+Utilities
+=========
+
+.. automodule:: pythermalcomfort.psychrometrics
     :members: