Updated docs style

revitron · Jun 11, 2020 · 1ed8680 · 1ed8680
1 parent d92ef51
commit 1ed8680
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 25 deletions.
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -0,0 +1,28 @@
+h1,
+h2,
+.navbar-nav > .active > .nav-link {
+    color: #333333 !important;
+}
+
+a.reference.internal,
+a.reference.internal > span {
+    color: #555555 !important;
+}
+
+.pre,
+.sig-prename.descclassname {
+    color: #858585;
+}
+
+a.headerlink,
+.sig-name.descname {
+    color: #5687b4;
+}
+
+a.headerlink:hover {
+    background-color: #5687b4;
+}
+
+main img {
+    margin: 30px 0;
+}
diff --git a/docs/source/_static/revitron-large.svg b/docs/source/_static/revitron-large.svg
diff --git a/docs/source/_static/revitron.svg b/docs/source/_static/revitron.svg
diff --git a/docs/source/_templates/package.rst_t b/docs/source/_templates/package.rst_t
@@ -16,7 +16,7 @@
 {%- if is_namespace %}
 {{- [pkgname, "namespace"] | join(" ") | e | heading }}
 {% else %}
-{{- "API Reference" | e | heading }}
+{{- "Revitron API Reference" | e | heading }}
 {% endif %}
 
 {%- if modulefirst and not is_namespace %}

diff --git a/docs/source/concept.rst b/docs/source/concept.rst
@@ -0,0 +1,2 @@
+Concept
+=======
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -71,7 +71,10 @@
 html_logo = "_static/revitron.svg"
 
 html_theme_options = {
-    "github_url": "https://github.com/revitron/revitron"
+    "external_links": [
+        {"url": "https://github.com/revitron/revitron-ui", "name": "Revitron UI"},
+        {"url": "https://github.com/revitron/revitron", "name": "GitHub"}
+    ]
 }
 
 html_context = {
@@ -84,4 +87,8 @@
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static']
+
+html_css_files = [
+    'custom.css',
+]
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -8,12 +8,15 @@ Revitron
 
 A python wrapper for the Revit API to be used as a pyRevit extension.
 
+.. image:: _static/revitron-large.svg
+
 .. toctree::
-   :maxdepth: 4
-
+   :maxdepth: 2
 
+   concept
+   install
    revitron
-   GitHub <https://github.com/revitron/revitron>
+
 
 Indices and tables
 ------------------

diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -0,0 +1,2 @@
+Install
+=======
diff --git a/docs/source/revitron.rst b/docs/source/revitron.rst
@@ -1,5 +1,5 @@
-API Reference
-=============
+Revitron API Reference
+======================
 
 .. automodule:: revitron
    :members: