Updated docs

revitron · Jun 11, 2020 · b83a5fd · b83a5fd
1 parent 4834d44
commit b83a5fd
Show file tree

Hide file tree

Showing 18 changed files with 143 additions and 49 deletions.
diff --git a/docs.bat b/docs.bat
@@ -1,6 +1,6 @@
 set cwd=%~dp0
 cd %cwd%
 cd docs
-sphinx-apidoc --private --ext-viewcode --ext-githubpages -e -T -M --implicit-namespaces -f -o source/ ../revitron
+sphinx-apidoc --ext-viewcode --templatedir source/_templates/ -eTMf -o source/ ../revitron
 call make html
 cd %cwd%
diff --git a/docs/source/_static/revitron.svg b/docs/source/_static/revitron.svg
diff --git a/docs/source/_templates/module.rst_t b/docs/source/_templates/module.rst_t
@@ -0,0 +1,8 @@
+{%- if show_headings %}
+{{- basename | e | heading }}
+
+{% endif -%}
+.. automodule:: {{ qualname }}
+{%- for option in automodule_options %}
+   :{{ option }}:
+{%- endfor %}
diff --git a/docs/source/_templates/package.rst_t b/docs/source/_templates/package.rst_t
@@ -0,0 +1,53 @@
+{%- macro automodule(modname, options) -%}
+.. automodule:: {{ modname }}
+{%- for option in options %}
+   :{{ option }}:
+{%- endfor %}
+{%- endmacro %}
+
+{%- macro toctree(docnames) -%}
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
+{%- endmacro %}
+
+{%- if is_namespace %}
+{{- [pkgname, "namespace"] | join(" ") | e | heading }}
+{% else %}
+{{- "API Reference" | e | heading }}
+{% endif %}
+
+{%- if modulefirst and not is_namespace %}
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}
+
+{%- if subpackages %}
+Subpackages
+-----------
+
+{{ toctree(subpackages) }}
+{% endif %}
+
+{%- if submodules %}
+Submodules
+----------
+{% if separatemodules %}
+{{ toctree(submodules) }}
+{%- else %}
+{%- for submodule in submodules %}
+{% if show_headings %}
+{{- [submodule, "module"] | join(" ") | e | heading(2) }}
+{% endif %}
+{{ automodule(submodule, automodule_options) }}
+{% endfor %}
+{%- endif %}
+{% endif %}
+
+{%- if not modulefirst and not is_namespace %}
+Module contents
+---------------
+
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}
diff --git a/docs/source/_templates/toc.rst_t b/docs/source/_templates/toc.rst_t
@@ -0,0 +1,7 @@
+{{ header | heading }}
+
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -64,7 +64,22 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
+
+
+html_theme = "pydata_sphinx_theme"
+html_logo = "_static/revitron.svg"
+
+html_theme_options = {
+    "github_url": "https://github.com/revitron/revitron"
+}
+
+html_context = {
+    "github_user": "revitron",
+    "github_repo": "revitron",
+    "github_version": "master",
+    "doc_path": "docs"
+}
 
 # 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,

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,17 +3,20 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Revitron's documentation!
-====================================
+Revitron 
+========
+
+A python wrapper for the Revit API to be used as a pyRevit extension.
 
 .. toctree::
    :maxdepth: 4
-   :caption: Contents:
+
 
    revitron
+   GitHub <https://github.com/revitron/revitron>
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`modindex`

diff --git a/docs/source/revitron.category.rst b/docs/source/revitron.category.rst
@@ -1,8 +1,7 @@
-revitron.category module
-========================
+revitron.category
+=================
 
 .. automodule:: revitron.category
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance:
diff --git a/docs/source/revitron.document.rst b/docs/source/revitron.document.rst
@@ -1,8 +1,7 @@
-revitron.document module
-========================
+revitron.document
+=================
 
 .. automodule:: revitron.document
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance:
diff --git a/docs/source/revitron.element.rst b/docs/source/revitron.element.rst
@@ -1,8 +1,7 @@
-revitron.element module
-=======================
+revitron.element
+================
 
 .. automodule:: revitron.element
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance:
diff --git a/docs/source/revitron.externalreference.rst b/docs/source/revitron.externalreference.rst
@@ -1,8 +1,7 @@
-revitron.externalreference module
-=================================
+revitron.externalreference
+==========================
 
 .. automodule:: revitron.externalreference
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance:
diff --git a/docs/source/revitron.filter.rst b/docs/source/revitron.filter.rst
@@ -1,8 +1,7 @@
-revitron.filter module
-======================
+revitron.filter
+===============
 
 .. automodule:: revitron.filter
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance:
diff --git a/docs/source/revitron.link.rst b/docs/source/revitron.link.rst
@@ -1,8 +1,7 @@
-revitron.link module
-====================
+revitron.link
+=============
 
 .. automodule:: revitron.link
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance:
diff --git a/docs/source/revitron.parameter.rst b/docs/source/revitron.parameter.rst
@@ -1,8 +1,7 @@
-revitron.parameter module
-=========================
+revitron.parameter
+==================
 
 .. automodule:: revitron.parameter
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance:
diff --git a/docs/source/revitron.rst b/docs/source/revitron.rst
@@ -1,11 +1,10 @@
-revitron package
-================
+API Reference
+=============
 
 .. automodule:: revitron
    :members:
    :undoc-members:
    :show-inheritance:
-   :private-members:
 
 Submodules
 ----------

diff --git a/docs/source/revitron.selection.rst b/docs/source/revitron.selection.rst
@@ -1,8 +1,7 @@
-revitron.selection module
-=========================
+revitron.selection
+==================
 
 .. automodule:: revitron.selection
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance:
diff --git a/docs/source/revitron.transaction.rst b/docs/source/revitron.transaction.rst
@@ -1,8 +1,7 @@
-revitron.transaction module
-===========================
+revitron.transaction
+====================
 
 .. automodule:: revitron.transaction
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance:
diff --git a/docs/source/revitron.transmissiondata.rst b/docs/source/revitron.transmissiondata.rst
@@ -1,8 +1,7 @@
-revitron.transmissiondata module
-================================
+revitron.transmissiondata
+=========================
 
 .. automodule:: revitron.transmissiondata
    :members:
    :undoc-members:
-   :show-inheritance:
-   :private-members:
+   :show-inheritance: