Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marcantondahmen committed Oct 16, 2020
1 parent 32d71cf commit 4e1e3f1
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 36 deletions.
3 changes: 3 additions & 0 deletions docs/source/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.landing .headerlink:after {
display: none !important;
}
2 changes: 1 addition & 1 deletion docs/source/_templates/package.rst_t
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
{%- if is_namespace %}
{{- [pkgname, "namespace"] | join(" ") | e | heading }}
{% else %}
{{- "Docs" | e | heading }}
{{- "Developer Guide" | e | heading }}
{% endif %}

{%- if modulefirst and not is_namespace %}
Expand Down
16 changes: 8 additions & 8 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,13 @@
html_favicon = '_static/favicon.ico'

html_context = {
'landing_page': {
'menu': [
{'title': 'Revitron UI', 'url': 'https://revitron-ui.readthedocs.io/'},
{'title': 'Docs', 'url': 'revitron.html'},
{'title': 'Package Manager', 'url': 'https://github.com/revitron/rpm#readme'},
]
}
'landing_page': {
'menu': [
{'title': 'Revitron UI', 'url': 'https://revitron-ui.readthedocs.io/'},
{'title': 'Developer Guide', 'url': 'revitron.html'},
{'title': 'RPM', 'url': 'https://github.com/revitron/rpm#readme'},
]
}
}

html_sidebars = {}
Expand All @@ -107,6 +107,6 @@
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_css_files = []
html_css_files = ['custom.css']

html_js_files = []
2 changes: 1 addition & 1 deletion docs/source/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Revitron library can be installed as a single Python package for **pyRevit**
In case you want to setup a new **Revit** project and you are new to pyRevit,
it is recommendend to install the bundled version as described below.

.. attention:: The bundle installer as well as the Revitron package manager are using **Git** to manage dependencies.
.. note:: The bundle installer as well as the Revitron package manager are using **Git** to manage dependencies.
Please make sure that `Git <https://git-scm.com/>`_ is installed properly on your system before installing Revitron.

Bundle Installer
Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ Revitron

.. container:: .buttons

`Get Started <get-started.html>`_
`GitHub <https://github.com/revitron/revitron>`_
`Get Started ⟶ <get-started.html>`_

.. toctree::
:caption: Revitron
Expand All @@ -28,6 +27,7 @@ Revitron
:hidden:

Revitron UI <https://revitron-ui.readthedocs.io/>
Package Manager <https://github.com/revitron/rpm#readme>
Tools <https://revitron-ui.readthedocs.io/en/latest/tools.html>
RPM <https://github.com/revitron/rpm#readme>
Unit Tests <https://github.com/revitron/revitron-tests>
GitHub <https://github.com/revitron/revitron>
4 changes: 2 additions & 2 deletions docs/source/revitron.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Docs
====
Developer Guide
===============

.. automodule:: revitron
:members:
Expand Down
2 changes: 1 addition & 1 deletion revitron/element.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Getting parameter values or other information can be quite complicated using the plain **Revit API**.
Methods like ``revitron.Element(element).get(parameter)`` simplify that process.
Attention:
Note:
Note that there is also the ``_()`` shortcut function available to be even more efficient
in getting properties of Revit elements. `More here <revitron.html#function>`_ ...
Expand Down
6 changes: 3 additions & 3 deletions revitron/parameter.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Parameter:
"""
A wrapper class for interacting with element parameters.
Attention:
Note:
In most cases it is not required to actually create a **Parameter** class
instance in order to access paramter values of a given element.
Expand Down Expand Up @@ -137,7 +137,7 @@ def get(self):
"""
Return the parameter value.
Attention:
Note:
As mentioned above, the fastest way of getting a parameter value is to use the
`get <revitron.element.html#revitron.element.Element.get>`_ method
Expand Down Expand Up @@ -227,7 +227,7 @@ def set(self, value, paramType = 'Text'):
"""
Set a parameter value for an element.
Attention:
Note:
As mentioned above, the fastest way of setting a parameter value is to use the
`set <revitron.element.html#revitron.element.Element.set>`_ method
Expand Down
17 changes: 0 additions & 17 deletions svg/revitron-white.svg

This file was deleted.

0 comments on commit 4e1e3f1

Please sign in to comment.