Skip to content

Commit

Permalink
Add brief testing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oruebel committed Aug 21, 2024
1 parent d904ca1 commit a869fdb
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/pages/0_install.dox
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
* cmake --build build --config Release
* \endcode
*
* Note, if you are using custom installations of HDF5 or BOOST that are not being detected
* \note
* If you are using custom installations of **HDF5** or **BOOST** that are not being detected
* automatically by cmake, you can specify `HDF5_ROOT` and `BOOST_ROOT` environment variables to
* point to install directories of HDF5 and BOOST respectively.
*
Expand Down
43 changes: 42 additions & 1 deletion docs/pages/devdocs/testing.dox
Original file line number Diff line number Diff line change
@@ -1,5 +1,46 @@
/**
* @page testing Testing
*
* Coming soon
* \section testing_unit Unit Tests
*
* `AqNWB` uses `ctest` and `CATCH2` for unit testing.
* Relevant files for the unit tests are located at:
* * ``/tests`` : Sources of the unit tests
* * ``/tests/examples`` : Sources of example code used in the docs. The examples are implemented like
* regular unit tests but their purpose is to provide examples for the docs (rather than testing
* specific cases) and as such commonly include Doxygen section markers to allow include of sections
* of code in the Doxygen docs.
*
*
* \subsection testing_unit_run Running Unit Tests
*
* If you built AqNWB with the `dev` mode preset, then simply call:
*
* \code{.sh}
* ctest --preset=dev
* \endcode
*
* Alternatively go to your build directory and run ``ctest`` directly, e.g.:
*
* \code{.sh}
* cd <my_build_dir>
* ctest
* \endcode
*
* \section testing_spellcheck Spellcheck
*
* AqNWB uses ``codepsell`` to check the code for spelling errors. You can run the spellchecker via:
*
* \code{.sh}
* cmake --build --preset=dev --target=spell-check
* \endcode
*
* \section testing_lint Linting
*
* AqNWB uses ``clang-format`` for linting the code. You can run the linter via:
*
* \code{.sh}
* cmake --build --preset=dev --target=format-check
* \endcode
*
*/

0 comments on commit a869fdb

Please sign in to comment.