update docs

biosimulators · Sep 16, 2024 · 9dce907 · 9dce907
1 parent 6ea462b
commit 9dce907
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 7 deletions.
diff --git a/documentation/build/doctrees/environment.pickle b/documentation/build/doctrees/environment.pickle
diff --git a/documentation/build/doctrees/installation.doctree b/documentation/build/doctrees/installation.doctree
diff --git a/documentation/build/html/_sources/installation.rst.txt b/documentation/build/html/_sources/installation.rst.txt
@@ -1,6 +1,8 @@
 Installation
 ============
 
+It is **highly recommended** to use a python environment manager like Poetry (https://python-poetry.org/docs/) to install BioCompose.
+
 To install `bio-compose`, you can use pip:
 
 .. code-block:: bash
@@ -12,8 +14,8 @@ If you are installing from source, clone the repository and use the following co
 .. code-block:: bash
 
    git clone https://github.com/biosimulators/bio-compose.git
-   cd your_project
-   pip install -e .
+   cd bio-compose
+   pip install .
 
 
 

diff --git a/documentation/build/html/installation.html b/documentation/build/html/installation.html
@@ -80,14 +80,15 @@
 
   <section id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
+<p>It is <strong>highly recommended</strong> to use a python environment manager like Poetry (<a class="reference external" href="https://python-poetry.org/docs/">https://python-poetry.org/docs/</a>) to install BioCompose.</p>
 <p>To install <cite>bio-compose</cite>, you can use pip:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>bio-compose
 </pre></div>
 </div>
 <p>If you are installing from source, clone the repository and use the following commands:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/biosimulators/bio-compose.git
-<span class="nb">cd</span><span class="w"> </span>your_project
-pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
+<span class="nb">cd</span><span class="w"> </span>bio-compose
+pip<span class="w"> </span>install<span class="w"> </span>.
 </pre></div>
 </div>
 </section>

diff --git a/documentation/build/html/searchindex.js b/documentation/build/html/searchindex.js
diff --git a/documentation/source/installation.rst b/documentation/source/installation.rst
@@ -1,6 +1,8 @@
 Installation
 ============
 
+It is **highly recommended** to use a python environment manager like Poetry (https://python-poetry.org/docs/) to install BioCompose.
+
 To install `bio-compose`, you can use pip:
 
 .. code-block:: bash
@@ -12,8 +14,8 @@ If you are installing from source, clone the repository and use the following co
 .. code-block:: bash
 
    git clone https://github.com/biosimulators/bio-compose.git
-   cd your_project
-   pip install -e .
+   cd bio-compose
+   pip install .