Skip to content

Commit 087e6f8

Browse files
authored
Small fix to docs deploy poetry install, update contrib md (#557)
* Small fix to docs deploy poetry install, update contrib md * Remove 'the' added by mistake
1 parent 9713c14 commit 087e6f8

File tree

3 files changed

+5
-12
lines changed

3 files changed

+5
-12
lines changed

.github/workflows/docs_build.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ jobs:
3737
poetry env use '3.10'
3838
source $(poetry env info --path)/bin/activate
3939
env MPICC=/opt/openmpi-4.1.5/bin/mpicc poetry install --with docs,dev,test --all-extras
40-
# pandoc README.md -f markdown -t rst -s -o docs/source/intro.rst
4140
cd docs && rm -rf source/reference/api/_autosummary && make html
4241
cd .. && coverage run -m pytest -m "not integration_test" && coverage xml && coverage report -m
4342
- name: Upload coverage to Codecov

.github/workflows/docs_deploy.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ jobs:
3838
ompi_info
3939
poetry env use '3.10'
4040
source $(poetry env info --path)/bin/activate
41-
env MPICC=/opt/openmpi-4.1.5/bin/mpicc poetry install --with test,dev --all-extras
42-
# pandoc README.md -f markdown -t rst -s -o docs/source/intro.rst
41+
env MPICC=/opt/openmpi-4.1.5/bin/mpicc poetry install --with docs,test,dev --all-extras
4342
cd docs && rm -rf source/reference/api/_autosummary && make html
4443
cd .. && coverage run -m pytest -m "not integration_test" && coverage xml && coverage report -m
4544
- name: Upload coverage to Codecov

CONTRIBUTING.md

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,12 @@ pre-commit run --all-files
1515

1616
## Coding guidelines
1717

18-
For code style, we recommend the [google style guide](https://google.github.io/styleguide/pyguide.html).
19-
20-
Pre-commit hooks apply the [black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
21-
code formatting.
18+
For code style, we recommend the [PEP 8 style guide](https://peps.python.org/pep-0008/).
2219

2320
For docstrings we use [numpy format](https://numpydoc.readthedocs.io/en/latest/format.html).
2421

25-
We also use [flake8](https://flake8.pycqa.org/en/latest/) and [pylint](https://pylint.pycqa.org/en/stable/)
26-
for further static code analysis. The pre-commit hooks show errors which you need
27-
to fix before submitting a PR.
22+
We use [ruff](https://docs.astral.sh/ruff/) for code formatting and static code
23+
analysis. Ruff checks various rules including [flake8](https://docs.astral.sh/ruff/faq/#how-does-ruff-compare-to-flake8). The pre-commit hooks show errors which you need to fix before submitting a PR.
2824

2925
Last but not the least, we use type hints in our code which is then checked using
30-
[mypy](https://mypy.readthedocs.io/en/stable/). Currently, mypy checks are not
31-
strict, but will be enforced more as the API code becomes more stable.
26+
[mypy](https://mypy.readthedocs.io/en/stable/).

0 commit comments

Comments
 (0)