update docs

revitron · Nov 10, 2022 · 1d26e6a · 1d26e6a
1 parent 32162f8
commit 1d26e6a
Show file tree

Hide file tree

Showing 36 changed files with 56 additions and 29 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
-sphinx==4.0.3
+sphinx==5.3.0
 https://github.com/revitron/revitron-sphinx-theme/archive/master.zip
 autodocsumm
 sphinxext-opengraph
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -41,4 +41,13 @@ th {
 
 .buttons-small a:after {
 	display: none;
+}
+
+.wy-menu .reference code {
+	background-color: transparent !important;
+}
+
+.wy-menu .reference code .pre {
+	font-size: 0.85rem !important;
+	line-height: 1.2 !important;
 }
diff --git a/docs/source/_templates/module.rst_t b/docs/source/_templates/module.rst_t
@@ -4,7 +4,6 @@
 {% endif -%}
 .. automodule:: {{ qualname }}
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -42,7 +42,7 @@
     'sphinxext.opengraph'
 ]
 
-autodoc_mock_imports = ['pyrevit', 'Autodesk', 'clr', 'System', 'Microsoft']
+autodoc_mock_imports = ['pyrevit', 'rpw', 'Autodesk', 'clr', 'System', 'Microsoft']
 
 add_module_names = False
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -22,6 +22,7 @@ Revitron
 
    get-started
    revitron
+   cli
    analyze
    cheat-sheet
    genindex

diff --git a/docs/source/revitron.analyze.history.rst b/docs/source/revitron.analyze.history.rst
@@ -3,7 +3,6 @@ revitron.analyze.history
 
 .. automodule:: revitron.analyze.history
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.analyze.providers.rst b/docs/source/revitron.analyze.providers.rst
@@ -3,7 +3,6 @@ revitron.analyze.providers
 
 .. automodule:: revitron.analyze.providers
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.analyze.storage.rst b/docs/source/revitron.analyze.storage.rst
@@ -3,7 +3,6 @@ revitron.analyze.storage
 
 .. automodule:: revitron.analyze.storage
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.boundingbox.rst b/docs/source/revitron.boundingbox.rst
@@ -3,7 +3,6 @@ revitron.boundingbox
 
 .. automodule:: revitron.boundingbox
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.category.rst b/docs/source/revitron.category.rst
@@ -3,7 +3,6 @@ revitron.category
 
 .. automodule:: revitron.category
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.create.rst b/docs/source/revitron.create.rst
@@ -3,7 +3,6 @@ revitron.create
 
 .. automodule:: revitron.create
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.document.rst b/docs/source/revitron.document.rst
@@ -3,7 +3,6 @@ revitron.document
 
 .. automodule:: revitron.document
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.element.rst b/docs/source/revitron.element.rst
@@ -3,7 +3,6 @@ revitron.element
 
 .. automodule:: revitron.element
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.excel.rst b/docs/source/revitron.excel.rst
@@ -3,7 +3,6 @@ revitron.excel
 
 .. automodule:: revitron.excel
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.export.rst b/docs/source/revitron.export.rst
@@ -3,7 +3,6 @@ revitron.export
 
 .. automodule:: revitron.export
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.externalreference.rst b/docs/source/revitron.externalreference.rst
@@ -3,7 +3,6 @@ revitron.externalreference
 
 .. automodule:: revitron.externalreference
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.failure.rst b/docs/source/revitron.failure.rst
@@ -3,7 +3,6 @@ revitron.failure
 
 .. automodule:: revitron.failure
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.filter.rst b/docs/source/revitron.filter.rst
@@ -3,7 +3,6 @@ revitron.filter
 
 .. automodule:: revitron.filter
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.geometry.rst b/docs/source/revitron.geometry.rst
@@ -3,7 +3,6 @@ revitron.geometry
 
 .. automodule:: revitron.geometry
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.grid.rst b/docs/source/revitron.grid.rst
@@ -3,7 +3,6 @@ revitron.grid
 
 .. automodule:: revitron.grid
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.link.rst b/docs/source/revitron.link.rst
@@ -3,7 +3,6 @@ revitron.link
 
 .. automodule:: revitron.link
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.parameter.rst b/docs/source/revitron.parameter.rst
@@ -3,7 +3,6 @@ revitron.parameter
 
 .. automodule:: revitron.parameter
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.raytrace.rst b/docs/source/revitron.raytrace.rst
@@ -3,7 +3,6 @@ revitron.raytrace
 
 .. automodule:: revitron.raytrace
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.room.rst b/docs/source/revitron.room.rst
@@ -3,7 +3,6 @@ revitron.room
 
 .. automodule:: revitron.room
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.roomtag.rst b/docs/source/revitron.roomtag.rst
@@ -3,7 +3,6 @@ revitron.roomtag
 
 .. automodule:: revitron.roomtag
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.rst b/docs/source/revitron.rst
@@ -14,6 +14,7 @@ Subpackages
    :maxdepth: 4
 
    revitron.analyze
+   revitron.ui
 
 Submodules
 ----------

diff --git a/docs/source/revitron.selection.rst b/docs/source/revitron.selection.rst
@@ -3,7 +3,6 @@ revitron.selection
 
 .. automodule:: revitron.selection
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.transaction.rst b/docs/source/revitron.transaction.rst
@@ -3,7 +3,6 @@ revitron.transaction
 
 .. automodule:: revitron.transaction
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.transmissiondata.rst b/docs/source/revitron.transmissiondata.rst
@@ -3,7 +3,6 @@ revitron.transmissiondata
 
 .. automodule:: revitron.transmissiondata
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.ui.button.rst b/docs/source/revitron.ui.button.rst
@@ -0,0 +1,8 @@
+revitron.ui.button
+==================
+
+.. automodule:: revitron.ui.button
+   :members:
+   :inherited-members:
+   :show-inheritance:
+   :autosummary:
diff --git a/docs/source/revitron.ui.form.rst b/docs/source/revitron.ui.form.rst
@@ -0,0 +1,8 @@
+revitron.ui.form
+================
+
+.. automodule:: revitron.ui.form
+   :members:
+   :inherited-members:
+   :show-inheritance:
+   :autosummary:
diff --git a/docs/source/revitron.ui.rst b/docs/source/revitron.ui.rst
@@ -0,0 +1,18 @@
+revitron.ui
+===========
+
+
+.. automodule:: revitron.ui
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   revitron.ui.button
+   revitron.ui.form
+   revitron.ui.window
diff --git a/docs/source/revitron.ui.window.rst b/docs/source/revitron.ui.window.rst
@@ -0,0 +1,8 @@
+revitron.ui.window
+==================
+
+.. automodule:: revitron.ui.window
+   :members:
+   :inherited-members:
+   :show-inheritance:
+   :autosummary:
diff --git a/docs/source/revitron.unit.rst b/docs/source/revitron.unit.rst
@@ -3,7 +3,6 @@ revitron.unit
 
 .. automodule:: revitron.unit
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/docs/source/revitron.view.rst b/docs/source/revitron.view.rst
@@ -3,7 +3,6 @@ revitron.view
 
 .. automodule:: revitron.view
    :members:
-   :undoc-members:
    :inherited-members:
    :show-inheritance:
    :autosummary:
diff --git a/revitron/analyze/__init__.py b/revitron/analyze/__init__.py
@@ -1,5 +1,5 @@
 """
-The ``analyze`` module helps you to automate analysing the health and status of a model and to extract 
+The ``revitron.analyze`` module helps you to automate analysing the health and status of a model and to extract 
 several types of data and statistics in order to simplifiy BIM quality control. Extracted data is stored 
 as snapshots in a SQLite database to be consumed by other applications or dashboards.
 """