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.

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

Update tests path in wheel build and docs #311

Merged
merged 5 commits into from
Aug 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ jobs:
env:
CIBW_BUILD: ${{ matrix.python }}*${{ matrix.arch }}
CIBW_TEST_REQUIRES: pytest neo[neomatlabio]>=0.5.1
CIBW_TEST_COMMAND: pytest -sx {project}/efel/tests
CIBW_TEST_COMMAND: pytest -sx {project}/tests
CIBW_SKIP: "*-musllinux_*"

steps:
Expand Down
14 changes: 7 additions & 7 deletions docs/source/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Requirements
As a developer you will need some extra requirements

* To get the latest source code: `Git <https://git-scm.com/>`_
* To run the tests: `Nose <https://nose.readthedocs.org/en/latest/>`_
* To run the tests: `Pytest <https://readthedocs.org/projects/pytest/>`_
* To build the documentation: `Sphinx <http://sphinx-doc.org/>`_, and pdflatex
(e.g. from `Mactex <https://tug.org/mactex/>`_)

Expand All @@ -34,7 +34,7 @@ To simplify certain tasks for developers, a Makefile is provided in the root of
the eFEL project. This Makefile has the following targets

* **install**: installs the eFEL using pip from the working directory
* **test**: run the installation and all the Nose tests
* **test**: run the installation and all the tests
* **doc**: build the sphinx and latex documentation
* **clean**: clean up the build directories
* **pypi**: run test target and upload to pypi
Expand Down Expand Up @@ -91,17 +91,17 @@ You can confirm everything compiles correctly by executing::
Adding a test
-------------
Most eFeatures are fairly easy to implement in Python, so it is advised to first
write a Python implementation of your eFeature, and to add it Nose tests.
write a Python implementation of your eFeature, and to add a test to it.
Then, while you are implementing the code in C++ you can easily compare the
results to the Nose test.
results to the test.

The Nose tests of the individual eFeatures are
`here_nose <https://github.com/BlueBrain/eFEL/blob/master/efel/tests/
The tests of the individual eFeatures are
`here <https://github.com/BlueBrain/eFEL/blob/master/tests/
test_basic.py>`_
.Just add your own test by defining a new function 'test_yourfeature()'.

Some test data is available
`here <https://github.com/BlueBrain/eFEL/tree/master/efel/tests/
`here <https://github.com/BlueBrain/eFEL/tree/master/tests/
testdata/basic>`_
, but you can of course add your own traces.

Expand Down
Loading
Loading