updated documentation

ansys · Jan 26, 2024 · 3c2a1e9 · 3c2a1e9
1 parent 275619d
commit 3c2a1e9
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -33,7 +33,11 @@ Pyconceptev core
 
 A Python wrapper for Ansys conceptev core
 
+.. WARNING::
+   Beware this api is in a state of rapid to change and should be considered unstable.
 
+.. WARNING::
+   The below is autogenerated for pyansys and needs updating to get started check index.rst
 How to install
 --------------
 

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -12,12 +12,33 @@ ConceptEV Specific Instructions
    Beware this api is in a state of rapid to change and should be considered unstable.
 
 
+
 You need to:
+- `Install the library`
 - `Configure Session using .env file`
 - `Get a token`
 - `Create a client`
 - `Understand the API` at https://dev-conceptev.awsansys3np.onscale.com/api/docs
 
+Install the library
+^^^^^^^^^^^^^
+
+#. Start by cloning this repository:
+
+   .. code:: bash
+
+      git clone https://github.com/ansys-internal/pyconceptev-core
+
+#. Install poetry:
+
+   .. code:: bash
+
+      pipx install poetry
+
+#. Install dependencies using poetry:
+   .. code:: bash
+
+    poetry install
 
 Configure Session using .env file
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^