From 7c9cd7dd023ff255201ebf4ff0f3eb64b20a242e Mon Sep 17 00:00:00 2001 From: pramodk Date: Thu, 22 Feb 2024 05:58:48 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20BlueBrai?= =?UTF-8?q?n/nmodl@1626deedb16bbf25f45fc9f69ca4eb30e9dabe84=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- html/contributing.html | 82 +++++++++++----------- html/doxygen/_r_e_a_d_m_e_8rst_source.html | 2 +- html/readme.html | 2 +- html/searchindex.js | 2 +- 4 files changed, 45 insertions(+), 43 deletions(-) diff --git a/html/contributing.html b/html/contributing.html index 4310ebf62b..a734bd7ff7 100644 --- a/html/contributing.html +++ b/html/contributing.html @@ -239,51 +239,53 @@

Submission Guidelines

Development Conventions

-

If you are developing NMODL, make sure to enable both -NMODL_FORMATTING and NMODL_PRECOMMIT CMake variables to ensure -that your contributions follow the coding conventions of this project:

-

.. code:: cmake

-

cmake -DNMODL_FORMATTING:BOOL=ON -DNMODL_PRECOMMIT:BOOL=ON

-

The first variable provides the following additional targets to format -C, C++, and CMake files:

-

::

-

make clang-format cmake-format

-

The second option activates Git hooks that will discard commits that do -not comply with coding conventions of this project. These 2 CMake -variables require additional utilities:

-
    -

  • ClangFormat 7 <https://releases.llvm.org/7.0.0/tools/clang/docs/ClangFormat.html>__

    • -

  • cmake-format <https://github.com/cheshirekow/cmake_format>__

    • -

  • pre-commit <https://pre-commit.com/>__

    • -
-

clang-format can be installed on Linux thanks to LLVM apt page <http://apt.llvm.org/>__. On MacOS, you can simply install llvm -with brew: brew install llvm. cmake-format and pre-commit -utilities can be installed with pip.

-

Validate the Python package

+

Formatting

+

+Run the HPC coding conventions formatter to format all source files:
+
+.. code:: bash
+
+   cmake/hpc-coding-conventions/bin/format
+
+The HPC coding conventions formatter installs any dependencies into a Python
+virtual environment.
+
+
+Validate the Python package
+
+
+

You may run the Python test-suites if your contribution has an impact on +the Python API:

+
    +

  1. setup a sandbox environment with either virtualenv, pyenv, or +pipenv. For instance with virtualenv: +python -m venv .venv && source .venv/bin/activate

    2. +

  2. build the Python package with the command: python setup.py build

    3. +

  3. install pytest Python package: pip install pytest

    4. +

  4. execute the unit-tests: pytest

    5. +
+

Memory Leaks and clang-tidy


-You may run the Python test-suites if your contribution has an impact on
-the Python API:
+If you want to test for memory leaks, do :
+
+::
+
+   valgrind --leak-check=full --track-origins=yes  ./bin/nmodl_lexer
+
+Or using CTest as:
+
+::
+
+   ctest -T memcheck
+
+If you want to enable ``clang-tidy`` checks with CMake, make sure to
+have ``CMake >= 3.15`` and use following cmake option:
 
-1. setup a sandbox environment with either *virtualenv*, *pyenv*, or
-   *pipenv*. For instance with *virtualenv*:
-   ``python -m venv .venv && source .venv/bin/activate``
-2. build the Python package with the command: ``python setup.py build``
-3. install *pytest* Python package: ``pip install pytest``
-4. execute the unit-tests: ``pytest``
+::
 
-Memory Leaks and clang-tidy
+   cmake .. -DENABLE_CLANG_TIDY=ON
-

If you want to test for memory leaks, do :

-

::

-

valgrind –leak-check=full –track-origins=yes ./bin/nmodl_lexer

-

Or using CTest as:

-

::

-

ctest -T memcheck

-

If you want to enable clang-tidy checks with CMake, make sure to -have CMake >= 3.15 and use following cmake option:

-

::

-

cmake .. -DENABLE_CLANG_TIDY=ON

diff --git a/html/doxygen/_r_e_a_d_m_e_8rst_source.html b/html/doxygen/_r_e_a_d_m_e_8rst_source.html index f5611cf804..70c9a36435 100644 --- a/html/doxygen/_r_e_a_d_m_e_8rst_source.html +++ b/html/doxygen/_r_e_a_d_m_e_8rst_source.html @@ -120,7 +120,7 @@
24 membrane and intracellular submodels. Here is an example of exponential
25 synapse specified in NMODL:
26 
-
27 .. code:: python
+
27 .. code::
28 
29  NEURON {
30  POINT_PROCESS ExpSyn
diff --git a/html/readme.html b/html/readme.html index d0f1d677b3..5d96b9b7d0 100644 --- a/html/readme.html +++ b/html/readme.html @@ -147,7 +147,7 @@

About NMODL