##// END OF EJS Templates
Merge branch 'main' into main
Nelson Ferreira -
r27959:718af292 merge
parent child Browse files
Show More
@@ -66,8 +66,9 b' Some guidelines on contributing to IPython:'
66 If you're making functional changes, you can clean up the specific pieces of
66 If you're making functional changes, you can clean up the specific pieces of
67 code you're working on.
67 code you're working on.
68
68
69 [Travis](http://travis-ci.org/#!/ipython/ipython) does a pretty good job testing
69 [GitHub Actions](https://github.com/ipython/ipython/actions/workflows/test.yml) does
70 IPython and Pull Requests, but it may make sense to manually perform tests,
70 a pretty good job testing IPython and Pull Requests,
71 but it may make sense to manually perform tests,
71 particularly for PRs that affect `IPython.parallel` or Windows.
72 particularly for PRs that affect `IPython.parallel` or Windows.
72
73
73 For more detailed information, see our [GitHub Workflow](https://github.com/ipython/ipython/wiki/Dev:-GitHub-workflow).
74 For more detailed information, see our [GitHub Workflow](https://github.com/ipython/ipython/wiki/Dev:-GitHub-workflow).
@@ -88,3 +89,30 b' Only a single test (for example **test_alias_lifecycle**) within a single file c'
88 ```shell
89 ```shell
89 pytest IPython/core/tests/test_alias.py::test_alias_lifecycle
90 pytest IPython/core/tests/test_alias.py::test_alias_lifecycle
90 ```
91 ```
92
93 ## Code style
94
95 * Before committing, run `darker -r 60625f241f298b5039cb2debc365db38aa7bb522 <file path>` to apply selective `black` formatting on modified regions using [darker](https://github.com/akaihola/darker).
96 * For newly added modules or refactors, please enable static typing analysis with `mypy` for the modified module by adding the file path in [`mypy.yml`](https://github.com/ipython/ipython/blob/main/.github/workflows/mypy.yml) workflow.
97 * As described in the pull requests section, please avoid excessive formatting changes; if a formatting-only commit is necessary, consider adding its hash to [`.git-blame-ignore-revs`](https://github.com/ipython/ipython/blob/main/.git-blame-ignore-revs) file.
98
99 ## Documentation
100
101 Sphinx documentation can be built locally using standard sphinx `make` commands. To build HTML documentation from the root of the project, execute:
102
103 ```shell
104 pip install -r docs/requirements.txt # only needed once
105 make -C docs/ html SPHINXOPTS="-W"
106 ```
107
108 To force update of the API documentation, precede the `make` command with:
109
110 ```shell
111 python3 docs/autogen_api.py
112 ```
113
114 Similarly, to force-update the configuration, run:
115
116 ```shell
117 python3 docs/autogen_config.py
118 ```
@@ -5,7 +5,7 b''
5 :target: https://pypi.python.org/pypi/ipython
5 :target: https://pypi.python.org/pypi/ipython
6
6
7 .. image:: https://github.com/ipython/ipython/actions/workflows/test.yml/badge.svg
7 .. image:: https://github.com/ipython/ipython/actions/workflows/test.yml/badge.svg
8 :target: https://github.com/ipython/ipython/actions/workflows/test.yml)
8 :target: https://github.com/ipython/ipython/actions/workflows/test.yml
9
9
10 .. image:: https://www.codetriage.com/ipython/ipython/badges/users.svg
10 .. image:: https://www.codetriage.com/ipython/ipython/badges/users.svg
11 :target: https://www.codetriage.com/ipython/ipython/
11 :target: https://www.codetriage.com/ipython/ipython/
@@ -8,6 +8,7 b" python -c 'import twine'"
8 python -c 'import sphinx'
8 python -c 'import sphinx'
9 python -c 'import sphinx_rtd_theme'
9 python -c 'import sphinx_rtd_theme'
10 python -c 'import pytest'
10 python -c 'import pytest'
11 python -c 'import build'
11
12
12
13
13 BLACK=$(tput setaf 1)
14 BLACK=$(tput setaf 1)
General Comments 0
You need to be logged in to leave comments. Login now