Skip to content

docs(nml): improve cell helper method docstrings #318

docs(nml): improve cell helper method docstrings

docs(nml): improve cell helper method docstrings #318

Workflow file for this run

name: Regenerate nml.py
on:
push:
branches: [ master, development, experimental ]
pull_request:
branches: [ master, development, experimental ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
sudo apt-get update -y
sudo apt-get install libhdf5-serial-dev liblzo2-dev libgraphviz-dev -y
python -m pip install --upgrade pip
pip install .[dev]
- name: Rebuild nml.py
run: |
cd neuroml/nml && rm -f nml.py && ./regenerate-nml.sh -a
- name: Build package
run: |
pip install .[full]
- name: Test with pytest
run: |
pytest
- name: Run examples
run: |
cd ./neuroml/examples && python run_all.py
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics