Skip to content

Commit

Permalink
Merge pull request pymeasure#1180 from DEMCON/feature/install-groups
Browse files Browse the repository at this point in the history
Added an install group for building documentation
  • Loading branch information
BenediktBurger authored Oct 25, 2024
2 parents ac122f2 + fdefe39 commit 54e335b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
13 changes: 9 additions & 4 deletions docs/dev/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,20 @@ If you had already installed PyMeasure using :code:`pip`, make sure to uninstall
pip uninstall pymeasure
Install PyMeasure in the editable mode.
Install PyMeasure in the editable mode and select optional extras.

.. code-block:: bash
cd /path/for/code/pymeasure
pip install -e .
pip install -e .[tests,docs]
This will allow you to edit the files of PyMeasure and see the changes reflected. Make sure to reset your notebook kernel or Python console when doing so. Now you have your own copy of the development version of PyMeasure installed!
Depending on your Python installation you may get an error messages saying that the file setup.py is missing or similar. Updating pip may solve the problem
The ``-e`` will allow you to edit the files of PyMeasure and see the changes reflected.
The square brackets include extra groups that allow you to run tests and build the documentation locally.
Make sure to reset your notebook kernel or Python console when doing so.
Now you have your own copy of the development version of PyMeasure installed!

Depending on your Python installation you may get an error messages saying that the file setup.py is missing or similar.
Updating pip may solve the problem.

.. code-block:: bash
Expand Down
3 changes: 3 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ tests =
pytest-cov >= 4.1.0
pytest-qt >= 2.4.0 # install pyqt or pyside manually as desired
pyvisa-sim >= 0.4.0
docs =
sphinx >= 5.0.0
sphinx_rtd_theme >= 1.1.0

[flake8]
exclude = .git,__pycache__,docs/conf.py,build,dist
Expand Down

0 comments on commit 54e335b

Please sign in to comment.