Skip to content

Commit

Permalink
Merge pull request #3 from daavid00/dev
Browse files Browse the repository at this point in the history
Updating the documentation
  • Loading branch information
daavid00 authored Jul 14, 2024
2 parents 295b97d + 203f936 commit d2a2d8e
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/_sources/api.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
plopm Python API
================

The main script (and the only one by now) for the **plopm** executable is located in the `core <https://github.com/cssr-tools/pycopm/blob/main/src/plopm/core>`_ folder.
The main script (and the only one by now) for the **plopm** executable is located in the `core <https://github.com/cssr-tools/plopm/blob/main/src/plopm/core>`_ folder.

.. include:: modules.rst
8 changes: 4 additions & 4 deletions docs/_sources/introduction.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The current implementation supports the following executable with the argument o

.. code-block:: bash
pycopm -i some_input -o some_output_folder
plopm -i some_input -o some_output_folder
where

Expand All @@ -42,14 +42,14 @@ where

Installation
------------
See the `Github page <https://github.com/cssr-tools/pycopm>`_.
See the `Github page <https://github.com/cssr-tools/plopm>`_.

.. tip::
Check the `CI.yml <https://github.com/cssr-tools/pycopm/blob/main/.github/workflows/CI.yml>`_ file.
Check the `CI.yml <https://github.com/cssr-tools/plopm/blob/main/.github/workflows/CI.yml>`_ file.

Getting started
---------------
See the :doc:`examples <./examples>`.

.. tip::
Check the `tests <https://github.com/cssr-tools/pycopm/blob/main/tests>`_.
Check the `tests <https://github.com/cssr-tools/plopm/blob/main/tests>`_.
2 changes: 1 addition & 1 deletion docs/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@

<section id="plopm-python-api">
<h1>plopm Python API<a class="headerlink" href="#plopm-python-api" title="Link to this heading"></a></h1>
<p>The main script (and the only one by now) for the <strong>plopm</strong> executable is located in the <a class="reference external" href="https://github.com/cssr-tools/pycopm/blob/main/src/plopm/core">core</a> folder.</p>
<p>The main script (and the only one by now) for the <strong>plopm</strong> executable is located in the <a class="reference external" href="https://github.com/cssr-tools/plopm/blob/main/src/plopm/core">core</a> folder.</p>
<section id="plopm">
<h2>plopm<a class="headerlink" href="#plopm" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
Expand Down
8 changes: 4 additions & 4 deletions docs/introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ <h2>Concept<a class="headerlink" href="#concept" title="Link to this heading">
<section id="overview">
<span id="id1"></span><h2>Overview<a class="headerlink" href="#overview" title="Link to this heading"></a></h2>
<p>The current implementation supports the following executable with the argument options:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pycopm<span class="w"> </span>-i<span class="w"> </span>some_input<span class="w"> </span>-o<span class="w"> </span>some_output_folder
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>plopm<span class="w"> </span>-i<span class="w"> </span>some_input<span class="w"> </span>-o<span class="w"> </span>some_output_folder
</pre></div>
</div>
<p>where</p>
Expand All @@ -119,18 +119,18 @@ <h2>Concept<a class="headerlink" href="#concept" title="Link to this heading">
</section>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h2>
<p>See the <a class="reference external" href="https://github.com/cssr-tools/pycopm">Github page</a>.</p>
<p>See the <a class="reference external" href="https://github.com/cssr-tools/plopm">Github page</a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Check the <a class="reference external" href="https://github.com/cssr-tools/pycopm/blob/main/.github/workflows/CI.yml">CI.yml</a> file.</p>
<p>Check the <a class="reference external" href="https://github.com/cssr-tools/plopm/blob/main/.github/workflows/CI.yml">CI.yml</a> file.</p>
</div>
</section>
<section id="getting-started">
<h2>Getting started<a class="headerlink" href="#getting-started" title="Link to this heading"></a></h2>
<p>See the <a class="reference internal" href="examples.html"><span class="doc">examples</span></a>.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>Check the <a class="reference external" href="https://github.com/cssr-tools/pycopm/blob/main/tests">tests</a>.</p>
<p>Check the <a class="reference external" href="https://github.com/cssr-tools/plopm/blob/main/tests">tests</a>.</p>
</div>
</section>
</section>
Expand Down
Loading

0 comments on commit d2a2d8e

Please sign in to comment.