Skip to content

Commit

Permalink
Merge branch 'master' into ruff
Browse files Browse the repository at this point in the history
  • Loading branch information
cclauss authored Dec 18, 2024
2 parents 421030d + ec491c5 commit 0420286
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
9 changes: 1 addition & 8 deletions .github/workflows/rstcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,5 @@ jobs:

steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install rstcheck
- name: Run rstcheck
run: |
python -m rstcheck --ignore-directives autofunction README.rst reference/*.rst
run: make rstcheck
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
lint:
# ignore errors for long lines and multi-statement lines
@pipx run flake8 --ignore=E501,E701,W503 .

rstcheck:
@pipx run rstcheck --ignore-directives autofunction README.rst reference/*.rst
4 changes: 3 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,8 @@ Releases are done by running ``make-release.sh VERSION_GOES_HERE`` to build the
Testing
~~~~~~~

Prerequisite: `Install pipx <https://pipx.pypa.io/stable/installation/>`__.

To run all the tests:

.. code:: bash
Expand All @@ -312,7 +314,7 @@ To ensure RST is well-formed:

.. code:: bash
python -m rstcheck README.rst reference/*.rst
make rstcheck
Testing is also done automatically by GitHub Actions, upon every push.

Expand Down

0 comments on commit 0420286

Please sign in to comment.