Skip to content

Commit

Permalink
improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
philipjusher committed Mar 5, 2024
1 parent f39f776 commit a9cb771
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Check failure on line 32 in doc/source/index.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/index.rst#L32

[Vale.Spelling] Did you really mean 'pipx'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'pipx'?", "location": {"path": "doc/source/index.rst", "range": {"start": {"line": 32, "column": 118}}}, "severity": "ERROR"}

.. code:: bash
Expand All @@ -40,6 +40,11 @@ Install the library
poetry install
#. Activate the poetry environment:
.. code:: bash
poetry shell
Configure Session using .env file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand All @@ -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()
Expand Down

0 comments on commit a9cb771

Please sign in to comment.