From a9cb771a102b7f0886babf321a36b56230e6a114 Mon Sep 17 00:00:00 2001 From: Philip Usher Date: Tue, 5 Mar 2024 12:17:13 +0000 Subject: [PATCH] improved docs --- doc/source/index.rst | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 28d3f8f..a4a871e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -29,7 +29,7 @@ Install the library git clone https://github.com/ansys-internal/pyconceptev-core -#. Install poetry: +#. Install poetry following your preferred route. See https://python-poetry.org/docs/#installation for example using pipx: .. code:: bash @@ -40,6 +40,11 @@ Install the library poetry install +#. Activate the poetry environment: + .. code:: bash + + poetry shell + Configure Session using .env file ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -59,7 +64,7 @@ Import the main module and use :code:`get_token` this should return a random str .. code-block:: python - import pyconceptev-core.main as pyconceptev #Test this + import ansys.conceptev.core.main as pyconceptev token = pyconceptev.get_token()