Skip to content

Commit

Permalink
Doc edits based on skimming rendered doc (#41)
Browse files Browse the repository at this point in the history
Co-authored-by: pyansys-ci-bot <[email protected]>
  • Loading branch information
PipKat and pyansys-ci-bot authored May 30, 2024
1 parent 25ae63c commit b155e6a
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 17 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ The documentation has these sections:
- `User guide <https://pyconceptev-core.docs.pyansys.com/version/stable/user_guide/index.html>`_: Learn how to
configure a PyConceptEV session, get a token, and create a client.
- `API reference <pyconceptev-core.docs.pyansys.com/version/stable/api/index.html>`_: Understand how the
`Ansys ConceptEV API documentation <https://conceptev.ansys.com/api/docs>`_ provides the verb functions
for interacting programmatically with PyConcept EV.
`Ansys ConceptEV API documentation <https://conceptev.ansys.com/api/docs>`_: Provides for interacting
programmatically with PyConcept EV.
- `Contribute <pyconceptev-core.docs.pyansys.com/version/stable//contributing.html>`_: Learn how to
contribute to PyConceptEV codebase or documentation.

Expand Down
1 change: 1 addition & 0 deletions doc/changelog.d/41.miscellaneous.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Doc edits based on skimming rendered doc
12 changes: 0 additions & 12 deletions doc/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,3 @@ Then, install PyConceptEV with this command:
.. code:: bash
python -m pip pip install ansys-conceptev-core
Install the library
^^^^^^^^^^^^^^^^^^^

#. Clone the repository:

.. code:: bash
git clone https://github.com/ansys-internal/pyconceptev-core
6 changes: 3 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ of EV powertrains.
:link-type: doc

Understand how the `Ansys ConceptEV API documentation <https://conceptev.ansys.com/api/docs>`_
provides the verb functions for interacting programmatically with PyConcept EV.
provides for interacting programmatically with PyConcept EV.

.. grid-item-card:: Contributing :material-regular:`group`
.. grid-item-card:: Contribute :material-regular:`group`
:padding: 2 2 2 2
:link: contributing
:link-type: doc
Expand All @@ -46,5 +46,5 @@ of EV powertrains.
getting_started
user_guide
api_ref
changelog
contributing
changelog

0 comments on commit b155e6a

Please sign in to comment.