Show More
@@ -77,4 +77,7 b' jobs:' | |||
|
77 | 77 | run: | |
|
78 | 78 | pytest --color=yes -raXxs ${{ startsWith(matrix.python-version, 'pypy') && ' ' || '--cov --cov-report=xml' }} |
|
79 | 79 | - name: Upload coverage to Codecov |
|
80 |
uses: codecov/codecov-action@v |
|
|
80 | uses: codecov/codecov-action@v3 | |
|
81 | with: | |
|
82 | name: Test | |
|
83 | files: /home/runner/work/ipython/ipython/coverage.xml |
@@ -66,8 +66,9 b' Some guidelines on contributing to IPython:' | |||
|
66 | 66 | If you're making functional changes, you can clean up the specific pieces of |
|
67 | 67 | code you're working on. |
|
68 | 68 | |
|
69 | [Travis](http://travis-ci.org/#!/ipython/ipython) does a pretty good job testing | |
|
70 | IPython and Pull Requests, but it may make sense to manually perform tests, | |
|
69 | [GitHub Actions](https://github.com/ipython/ipython/actions/workflows/test.yml) does | |
|
70 | a pretty good job testing IPython and Pull Requests, | |
|
71 | but it may make sense to manually perform tests, | |
|
71 | 72 | particularly for PRs that affect `IPython.parallel` or Windows. |
|
72 | 73 | |
|
73 | 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 | 89 | ```shell |
|
89 | 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 | 5 | :target: https://pypi.python.org/pypi/ipython |
|
6 | 6 | |
|
7 | 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 | 10 | .. image:: https://www.codetriage.com/ipython/ipython/badges/users.svg |
|
11 | 11 | :target: https://www.codetriage.com/ipython/ipython/ |
@@ -128,7 +128,6 b' More powerful methods' | |||
|
128 | 128 | |
|
129 | 129 | Displays the object as a side effect; the return value is ignored. If this |
|
130 | 130 | is defined, all other display methods are ignored. |
|
131 | This method is ignored in the REPL. | |
|
132 | 131 | |
|
133 | 132 | |
|
134 | 133 | Metadata |
@@ -14,18 +14,10 b' addopts = --durations=10' | |||
|
14 | 14 | --ignore=IPython/sphinxext |
|
15 | 15 | --ignore=IPython/terminal/pt_inputhooks |
|
16 | 16 | --ignore=IPython/__main__.py |
|
17 | --ignore=IPython/config.py | |
|
18 | --ignore=IPython/frontend.py | |
|
19 | --ignore=IPython/html.py | |
|
20 | --ignore=IPython/nbconvert.py | |
|
21 | --ignore=IPython/nbformat.py | |
|
22 | --ignore=IPython/parallel.py | |
|
23 | --ignore=IPython/qt.py | |
|
24 | 17 | --ignore=IPython/external/qt_for_kernel.py |
|
25 | 18 | --ignore=IPython/html/widgets/widget_link.py |
|
26 | 19 | --ignore=IPython/html/widgets/widget_output.py |
|
27 | 20 | --ignore=IPython/terminal/console.py |
|
28 | --ignore=IPython/terminal/ptshell.py | |
|
29 | 21 | --ignore=IPython/utils/_process_cli.py |
|
30 | 22 | --ignore=IPython/utils/_process_posix.py |
|
31 | 23 | --ignore=IPython/utils/_process_win32.py |
General Comments 0
You need to be logged in to leave comments.
Login now