update for installation docs

biosimulators · Sep 3, 2024 · a796bde · a796bde
1 parent 30767dd
commit a796bde
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/documentation/source/index.rst b/documentation/source/index.rst
@@ -12,6 +12,7 @@ Create, execute, and introspect reproducible composite simulations of dynamic bi
    :maxdepth: 2
    :caption: Contents:
 
+   installation
    modules
 
 .. automodule:: bio_compose

diff --git a/documentation/source/installation.rst b/documentation/source/installation.rst
@@ -0,0 +1,16 @@
+Installation
+============
+
+To install `bio-compose`, you can use pip:
+
+.. code-block:: bash
+
+   pip install bio-compose
+
+If you are installing from source, clone the repository and use the following commands:
+
+.. code-block:: bash
+
+   git clone https://github.com/biosimulators/bio-compose.git
+   cd your_project
+   pip install -e .
diff --git a/pyproject.toml b/pyproject.toml
@@ -20,7 +20,6 @@ sphinx = "^8.0.2"
 sphinx-autodoc-typehints = "^2.2.3"
 
 [project.optional-dependencies]
-# documentation = ["sphinx-autodoc-typehints>=2.3.0", "sphinx_rtd_theme", "mock"]
 documentation = ["sphinx-autodoc-typehints"]
 
 [tool.pytest.ini_options]