Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: test and docs instructions in contribution guide #3479

Merged
merged 1 commit into from
Nov 13, 2024
Merged

fix: test and docs instructions in contribution guide #3479

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions doc/source/contributing/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,29 @@ Clone the repository
Follow the steps in the Development Installation section of :ref:`ref_installation`
to set PyFluent up in development mode.

Run unit tests
--------------

To run the PyFluent unit tests, execute the following command in the root
(``pyfluent``) directory of the repository:

.. code:: console

poetry install --with test
poetry run pytest ----fluent-version=24.2

You can change the Fluent version by replacing ``24.2`` with the version you want to test.

Build documentation
-------------------
To build the PyFluent documentation locally, run the following commands in the root
(``pyfluent``) directory of the repository:

.. code::
.. code:: console

poetry install --with docs
cd doc
make html
poetry run make html

After the build completes, the HTML documentation is located in the
``_build/html`` directory. You can load the ``index.html`` file in
Expand Down Expand Up @@ -73,4 +86,4 @@ Or, you can directly execute `pre-commit <https://pre-commit.com/>`_ with:

.. code:: bash

pre-commit run --all-files --show-diff-on-failure
pre-commit run --all-files --show-diff-on-failure