Skip to content

Commit 7306532

Browse files
author
lisajulia
committed
Deploying to gh-pages from @ a43be65 🚀
1 parent 3e57401 commit 7306532

6 files changed

Lines changed: 11 additions & 11 deletions

File tree

master/.doctrees/common.doctree

5.12 KB
Binary file not shown.
469 Bytes
Binary file not shown.

master/_sources/common.rst.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ OPM Common Python Documentation
44
Note on Import Paths
55
--------------------
66

7-
In this documentation, some classes are referenced with their full import paths (e.g., opm.io.deck.DeckItem), while others are shown with just the class name. This distinction reflects how these classes are structured within the package:
7+
In this documentation, some classes are referenced with their full import paths (e.g., `opm.io.ecl.EGrid <common.html#opm.io.ecl.EGrid>`_), while others are shown with just the class name. This distinction reflects how these classes are structured within the package:
88

9-
- Fully Qualified Class Names: Classes displayed with their full import paths can be imported from their respective modules. They have constructors and can be directly instantiated in Python using the __init__ method. For example:
10-
.. code-block:: python
9+
- Fully Qualified Class Names: Classes displayed with their full import paths can be imported from their respective modules. They have constructors and can be directly instantiated in Python using the ``__init__`` method. For example:
1110

12-
from opm.io.deck import DeckItem
11+
.. code-block:: python
12+
13+
from opm.io.ecl import EGrid
1314
1415
1516
- Unqualified Class Names: Classes displayed with just their names, e.g., Connection, do not have constructors in Python and cannot be directly instantiated in Python. Objects of these classes might be return values of methods of other classes.

master/common.html

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -324,14 +324,13 @@
324324
<h1>OPM Common Python Documentation<a class="headerlink" href="#opm-common-python-documentation" title="Link to this heading"></a></h1>
325325
<section id="note-on-import-paths">
326326
<h2>Note on Import Paths<a class="headerlink" href="#note-on-import-paths" title="Link to this heading"></a></h2>
327-
<p>In this documentation, some classes are referenced with their full import paths (e.g., opm.io.deck.DeckItem), while others are shown with just the class name. This distinction reflects how these classes are structured within the package:</p>
328-
<ul class="simple">
329-
<li><p>Fully Qualified Class Names: Classes displayed with their full import paths can be imported from their respective modules. They have constructors and can be directly instantiated in Python using the __init__ method. For example:</p></li>
330-
</ul>
331-
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">opm.io.deck</span> <span class="kn">import</span> <span class="n">DeckItem</span>
327+
<p>In this documentation, some classes are referenced with their full import paths (e.g., <a class="reference external" href="common.html#opm.io.ecl.EGrid">opm.io.ecl.EGrid</a>), while others are shown with just the class name. This distinction reflects how these classes are structured within the package:</p>
328+
<ul>
329+
<li><p>Fully Qualified Class Names: Classes displayed with their full import paths can be imported from their respective modules. They have constructors and can be directly instantiated in Python using the <code class="docutils literal notranslate"><span class="pre">__init__</span></code> method. For example:</p>
330+
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">opm.io.ecl</span> <span class="kn">import</span> <span class="n">EGrid</span>
332331
</pre></div>
333332
</div>
334-
<ul class="simple">
333+
</li>
335334
<li><p>Unqualified Class Names: Classes displayed with just their names, e.g., Connection, do not have constructors in Python and cannot be directly instantiated in Python. Objects of these classes might be return values of methods of other classes.</p></li>
336335
</ul>
337336
</section>

master/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)