Skip to content

Commit

Permalink
Commit with New Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gtalarico committed Jun 19, 2017
1 parent 0788c38 commit 6a3bcff
Show file tree
Hide file tree
Showing 43 changed files with 788 additions and 68 deletions.
Binary file modified docs/_build/doctrees/base.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/console.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/element.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/forms.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/geometry.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/revitpythonshell.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/selection.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/tests.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/transaction.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/utils.doctree
Binary file not shown.
Binary file added docs/_build/html/_images/console.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/_build/html/_sources/console.rst.txt
@@ -0,0 +1,28 @@
.. revitpythonwrapper documentation master file, created by
sphinx-quickstart on Mon Oct 31 13:57:34 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==================
Console
==================

Interactive Console
*******************

.. image:: _static/forms/console.png

.. autoclass:: rpw.ui.Console
:special-members: __init__



----------------------------------------------

Implementation
**************

.. literalinclude:: ../rpw/ui/console.py

.. disqus
3 changes: 0 additions & 3 deletions docs/_build/html/_sources/element.rst.txt
Expand Up @@ -20,9 +20,6 @@ Element
:special-members: __init__, __getattr__
:show-inheritance:

.. data:: parameters
:annotation: access Element wrapped Parameters

Instance
************

Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/_sources/index.rst.txt
Expand Up @@ -22,6 +22,7 @@ Revit Python Wrapper
geometry
builtins
forms
console
utils
dynamo
revitpythonshell
Expand Down
Binary file added docs/_build/html/_static/forms/console.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/_build/html/base.html
Expand Up @@ -104,6 +104,7 @@
<li class="toctree-l1"><a class="reference internal" href="geometry.html">Geometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="builtins.html">Enumeration</a></li>
<li class="toctree-l1"><a class="reference internal" href="forms.html">Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="console.html">Console</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamo.html">Dynamo</a></li>
<li class="toctree-l1"><a class="reference internal" href="revitpythonshell.html">RevitPythonShell</a></li>
Expand Down Expand Up @@ -248,7 +249,7 @@ <h2>Implementation<a class="headerlink" href="#implementation" title="Permalink

<span class="kn">import</span> <span class="nn">rpw</span>
<span class="kn">from</span> <span class="nn">rpw.exceptions</span> <span class="k">import</span> <span class="n">RpwTypeError</span><span class="p">,</span> <span class="n">RpwException</span>
<span class="kn">from</span> <span class="nn">rpw.utils</span> <span class="k">import</span> <span class="n">logger</span>
<span class="kn">from</span> <span class="nn">rpw.utils.logger</span> <span class="k">import</span> <span class="n">logger</span>


<span class="k">class</span> <span class="nc">BaseObject</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/builtins.html
Expand Up @@ -104,6 +104,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="forms.html">Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="console.html">Console</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamo.html">Dynamo</a></li>
<li class="toctree-l1"><a class="reference internal" href="revitpythonshell.html">RevitPythonShell</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/collector.html
Expand Up @@ -104,6 +104,7 @@
<li class="toctree-l1"><a class="reference internal" href="geometry.html">Geometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="builtins.html">Enumeration</a></li>
<li class="toctree-l1"><a class="reference internal" href="forms.html">Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="console.html">Console</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamo.html">Dynamo</a></li>
<li class="toctree-l1"><a class="reference internal" href="revitpythonshell.html">RevitPythonShell</a></li>
Expand Down
579 changes: 579 additions & 0 deletions docs/_build/html/console.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/_build/html/dynamo.html
Expand Up @@ -101,6 +101,7 @@
<li class="toctree-l1"><a class="reference internal" href="geometry.html">Geometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="builtins.html">Enumeration</a></li>
<li class="toctree-l1"><a class="reference internal" href="forms.html">Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="console.html">Console</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">Utilities</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Dynamo</a></li>
<li class="toctree-l1"><a class="reference internal" href="revitpythonshell.html">RevitPythonShell</a></li>
Expand Down
30 changes: 13 additions & 17 deletions docs/_build/html/element.html
Expand Up @@ -116,6 +116,7 @@
<li class="toctree-l1"><a class="reference internal" href="geometry.html">Geometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="builtins.html">Enumeration</a></li>
<li class="toctree-l1"><a class="reference internal" href="forms.html">Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="console.html">Console</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamo.html">Dynamo</a></li>
<li class="toctree-l1"><a class="reference internal" href="revitpythonshell.html">RevitPythonShell</a></li>
Expand Down Expand Up @@ -199,9 +200,9 @@ <h1>Element Wrappers<a class="headerlink" href="#element-wrappers" title="Permal
</div>
<dl class="class">
<dt id="rpw.db.Element">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Element</code><a class="headerlink" href="#rpw.db.Element" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Element</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.Element" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="base.html#rpw.base.BaseObjectWrapper" title="rpw.base.BaseObjectWrapper"><code class="xref py py-class docutils literal"><span class="pre">rpw.base.BaseObjectWrapper</span></code></a></p>
<p>Inheriting from element extends wrapped elements with a new <a class="reference internal" href="#rpw.db.element.parameters" title="rpw.db.element.parameters"><code class="xref py py-class docutils literal"><span class="pre">parameters</span></code></a>
<p>Inheriting from element extends wrapped elements with a new <a class="reference internal" href="#rpw.db.element.Element.parameters" title="rpw.db.element.Element.parameters"><code class="xref py py-class docutils literal"><span class="pre">parameters</span></code></a>
attribute, well as the <a class="reference internal" href="#rpw.db.element.Element.unwrap" title="rpw.db.element.Element.unwrap"><code class="xref py py-func docutils literal"><span class="pre">unwrap()</span></code></a> method inherited from the <a class="reference internal" href="base.html#rpw.base.BaseObjectWrapper" title="rpw.base.BaseObjectWrapper"><code class="xref any py py-class docutils literal"><span class="pre">BaseObjectWrapper</span></code></a> class.</p>
<p>It can be created by instantiating <code class="docutils literal"><span class="pre">rpw.db.Element</span></code> , or one of the helper
static methods shown below.</p>
Expand Down Expand Up @@ -250,7 +251,7 @@ <h1>Element Wrappers<a class="headerlink" href="#element-wrappers" title="Permal

<dl class="method">
<dt id="rpw.db.Element.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.Element.__init__" title="Permalink to this definition"></a></dt>
<code class="descname">__init__</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.Element.__init__" title="Permalink to this definition"></a></dt>
<dd><div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">wall</span> <span class="o">=</span> <span class="n">Element</span><span class="p">(</span><span class="n">SomeElementId</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">wall</span><span class="o">.</span><span class="n">parameters</span><span class="p">[</span><span class="s1">&#39;Height&#39;</span><span class="p">]</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">wall</span><span class="o">.</span><span class="n">parameters</span><span class="o">.</span><span class="n">builtins</span><span class="p">[</span><span class="s1">&#39;WALL_LOCATION_LINE&#39;</span><span class="p">]</span>
Expand Down Expand Up @@ -288,17 +289,12 @@ <h1>Element Wrappers<a class="headerlink" href="#element-wrappers" title="Permal

</dd></dl>

<dl class="data">
<dt id="rpw.db.element.parameters">
<code class="descclassname">rpw.db.element.</code><code class="descname">parameters</code><em class="property"> access Element wrapped Parameters</em><a class="headerlink" href="#rpw.db.element.parameters" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</div>
<div class="section" id="instance">
<h2>Instance<a class="headerlink" href="#instance" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="rpw.db.Instance">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Instance</code><a class="headerlink" href="#rpw.db.Instance" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Instance</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.Instance" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">rpw.db.element.Element</span></code></p>
<p><cite>DB.FamilyInstance</cite> Wrapper</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">instance</span> <span class="o">=</span> <span class="n">rpw</span><span class="o">.</span><span class="n">Instance</span><span class="p">(</span><span class="n">SomeFamilyInstance</span><span class="p">)</span>
Expand Down Expand Up @@ -346,7 +342,7 @@ <h2>Instance<a class="headerlink" href="#instance" title="Permalink to this head
<h2>Symbol<a class="headerlink" href="#symbol" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="rpw.db.Symbol">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Symbol</code><a class="headerlink" href="#rpw.db.Symbol" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Symbol</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.Symbol" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">rpw.db.element.Element</span></code></p>
<p><cite>DB.FamilySymbol</cite> Wrapper</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">symbol</span> <span class="o">=</span> <span class="n">rpw</span><span class="o">.</span><span class="n">Symbol</span><span class="p">(</span><span class="n">SomeSymbol</span><span class="p">)</span>
Expand Down Expand Up @@ -400,7 +396,7 @@ <h2>Symbol<a class="headerlink" href="#symbol" title="Permalink to this headline
<h2>Family<a class="headerlink" href="#family" title="Permalink to this headline"></a></h2>
<dl class="class">
<dt id="rpw.db.Family">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Family</code><a class="headerlink" href="#rpw.db.Family" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Family</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.Family" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">rpw.db.element.Element</span></code></p>
<p><cite>DB.Family</cite> Wrapper</p>
<dl class="docutils">
Expand Down Expand Up @@ -511,15 +507,15 @@ <h2>Walls<a class="headerlink" href="#walls" title="Permalink to this headline">
</div>
<dl class="class">
<dt id="rpw.db.WallInstance">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">WallInstance</code><a class="headerlink" href="#rpw.db.WallInstance" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">WallInstance</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.WallInstance" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">rpw.db.element.Instance</span></code></p>
<p>Inherits base <code class="docutils literal"><span class="pre">Instance</span></code> and overrides symbol attribute to
get <cite>Symbol</cite> equivalent of Wall <cite>(GetTypeId)</cite></p>
</dd></dl>

<dl class="class">
<dt id="rpw.db.WallSymbol">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">WallSymbol</code><a class="headerlink" href="#rpw.db.WallSymbol" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">WallSymbol</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.WallSymbol" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">rpw.db.element.Symbol</span></code></p>
<dl class="docutils">
<dt>Inherits from <a class="reference internal" href="#rpw.db.Symbol" title="rpw.db.Symbol"><code class="xref any py py-class docutils literal"><span class="pre">Symbol</span></code></a> and overrides:</dt>
Expand All @@ -533,7 +529,7 @@ <h2>Walls<a class="headerlink" href="#walls" title="Permalink to this headline">

<dl class="class">
<dt id="rpw.db.WallFamily">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">WallFamily</code><a class="headerlink" href="#rpw.db.WallFamily" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">WallFamily</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.WallFamily" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">rpw.db.element.Family</span></code></p>
<p>Inherits base <code class="docutils literal"><span class="pre">Family</span></code> and overrides methods for Wall Instance`</p>
</dd></dl>
Expand All @@ -556,7 +552,7 @@ <h2>Spatial Elements<a class="headerlink" href="#spatial-elements" title="Permal
<p>Room Wrapper</p>
<dl class="class">
<dt id="rpw.db.Room">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Room</code><a class="headerlink" href="#rpw.db.Room" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Room</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.Room" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">rpw.db.element.Element</span></code></p>
<p><cite>DB.Architecture.Room</cite> Wrapper
Inherits from <a class="reference internal" href="#rpw.db.Element" title="rpw.db.Element"><code class="xref any py py-class docutils literal"><span class="pre">Element</span></code></a></p>
Expand Down Expand Up @@ -607,7 +603,7 @@ <h2>Spatial Elements<a class="headerlink" href="#spatial-elements" title="Permal
<p>Area Wrapper</p>
<dl class="class">
<dt id="rpw.db.Area">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Area</code><a class="headerlink" href="#rpw.db.Area" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">Area</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.Area" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">rpw.db.spatial_element.Room</span></code></p>
<p><cite>DB.Area</cite> Wrapper
Inherits from <a class="reference internal" href="#rpw.db.Room" title="rpw.db.Room"><code class="xref any py py-class docutils literal"><span class="pre">Room</span></code></a></p>
Expand Down Expand Up @@ -648,7 +644,7 @@ <h2>Spatial Elements<a class="headerlink" href="#spatial-elements" title="Permal
<p>Area Scheme Wrapper</p>
<dl class="class">
<dt id="rpw.db.AreaScheme">
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">AreaScheme</code><a class="headerlink" href="#rpw.db.AreaScheme" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">rpw.db.</code><code class="descname">AreaScheme</code><span class="sig-paren">(</span><em>element</em>, <em>doc=Document</em><span class="sig-paren">)</span><a class="headerlink" href="#rpw.db.AreaScheme" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">rpw.db.element.Element</span></code></p>
<p><cite>DB.AreaScheme</cite> Wrapper
Inherits from <a class="reference internal" href="#rpw.db.Element" title="rpw.db.Element"><code class="xref any py py-class docutils literal"><span class="pre">Element</span></code></a></p>
Expand Down
1 change: 1 addition & 0 deletions docs/_build/html/exceptions.html
Expand Up @@ -101,6 +101,7 @@
<li class="toctree-l1"><a class="reference internal" href="geometry.html">Geometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="builtins.html">Enumeration</a></li>
<li class="toctree-l1"><a class="reference internal" href="forms.html">Forms</a></li>
<li class="toctree-l1"><a class="reference internal" href="console.html">Console</a></li>
<li class="toctree-l1"><a class="reference internal" href="utils.html">Utilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="dynamo.html">Dynamo</a></li>
<li class="toctree-l1"><a class="reference internal" href="revitpythonshell.html">RevitPythonShell</a></li>
Expand Down

0 comments on commit 6a3bcff

Please sign in to comment.