Show More
@@ -1,35 +1,36 b'' | |||||
1 | name: Build docs |
|
1 | name: Build docs | |
2 |
|
2 | |||
3 | on: [push, pull_request] |
|
3 | on: [push, pull_request] | |
4 |
|
4 | |||
5 | jobs: |
|
5 | jobs: | |
6 | build: |
|
6 | build: | |
7 | runs-on: ubuntu-latest |
|
7 | runs-on: ubuntu-latest | |
8 |
|
8 | |||
9 | steps: |
|
9 | steps: | |
10 | - uses: actions/checkout@v2 |
|
10 | - uses: actions/checkout@v2 | |
11 | - name: Set up Python 3.8 |
|
11 | - name: Set up Python 3.8 | |
12 | uses: actions/setup-python@v2 |
|
12 | uses: actions/setup-python@v2 | |
13 | with: |
|
13 | with: | |
14 | python-version: 3.8 |
|
14 | python-version: 3.8 | |
15 | - name: Install Graphviz |
|
15 | - name: Install Graphviz | |
16 | run: | |
|
16 | run: | | |
17 | sudo apt-get update |
|
17 | sudo apt-get update | |
18 | sudo apt-get install graphviz |
|
18 | sudo apt-get install graphviz | |
19 | - name: Install Python dependencies |
|
19 | - name: Install Python dependencies | |
20 | run: | |
|
20 | run: | | |
21 | python -m pip install --upgrade pip setuptools coverage |
|
21 | python -m pip install --upgrade pip setuptools coverage rstvalidator | |
22 | pip install -r docs/requirements.txt |
|
22 | pip install -r docs/requirements.txt | |
23 | - name: Build docs |
|
23 | - name: Build docs | |
24 | run: | |
|
24 | run: | | |
|
25 | python -m rstvalidator long_description.rst | |||
25 | python tools/fixup_whats_new_pr.py |
|
26 | python tools/fixup_whats_new_pr.py | |
26 | make -C docs/ html SPHINXOPTS="-W" \ |
|
27 | make -C docs/ html SPHINXOPTS="-W" \ | |
27 | PYTHON="coverage run -a" \ |
|
28 | PYTHON="coverage run -a" \ | |
28 | SPHINXBUILD="coverage run -a -m sphinx.cmd.build" |
|
29 | SPHINXBUILD="coverage run -a -m sphinx.cmd.build" | |
29 | - name: Generate coverage xml |
|
30 | - name: Generate coverage xml | |
30 | run: | |
|
31 | run: | | |
31 | coverage combine `find . -name .coverage\*` && coverage xml |
|
32 | coverage combine `find . -name .coverage\*` && coverage xml | |
32 | - name: Upload coverage to Codecov |
|
33 | - name: Upload coverage to Codecov | |
33 | uses: codecov/codecov-action@v2 |
|
34 | uses: codecov/codecov-action@v2 | |
34 | with: |
|
35 | with: | |
35 | name: Docs |
|
36 | name: Docs |
@@ -1,37 +1,37 b'' | |||||
1 | IPython provides a rich toolkit to help you make the most out of using Python |
|
1 | IPython provides a rich toolkit to help you make the most out of using Python | |
2 | interactively. Its main components are: |
|
2 | interactively. Its main components are: | |
3 |
|
3 | |||
4 | * A powerful interactive Python shell |
|
4 | * A powerful interactive Python shell | |
5 | * A `Jupyter <https://jupyter.org/>`_ kernel to work with Python code in Jupyter |
|
5 | * A `Jupyter <https://jupyter.org/>`_ kernel to work with Python code in Jupyter | |
6 | notebooks and other interactive frontends. |
|
6 | notebooks and other interactive frontends. | |
7 |
|
7 | |||
8 | The enhanced interactive Python shells have the following main features: |
|
8 | The enhanced interactive Python shells have the following main features: | |
9 |
|
9 | |||
10 | * Comprehensive object introspection. |
|
10 | * Comprehensive object introspection. | |
11 |
|
11 | |||
12 | * Input history, persistent across sessions. |
|
12 | * Input history, persistent across sessions. | |
13 |
|
13 | |||
14 | * Caching of output results during a session with automatically generated |
|
14 | * Caching of output results during a session with automatically generated | |
15 | references. |
|
15 | references. | |
16 |
|
16 | |||
17 | * Extensible tab completion, with support by default for completion of python |
|
17 | * Extensible tab completion, with support by default for completion of python | |
18 | variables and keywords, filenames and function keywords. |
|
18 | variables and keywords, filenames and function keywords. | |
19 |
|
19 | |||
20 | * Extensible system of 'magic' commands for controlling the environment and |
|
20 | * Extensible system of 'magic' commands for controlling the environment and | |
21 | performing many tasks related either to IPython or the operating system. |
|
21 | performing many tasks related either to IPython or the operating system. | |
22 |
|
22 | |||
23 | * A rich configuration system with easy switching between different setups |
|
23 | * A rich configuration system with easy switching between different setups | |
24 | (simpler than changing $PYTHONSTARTUP environment variables every time). |
|
24 | (simpler than changing $PYTHONSTARTUP environment variables every time). | |
25 |
|
25 | |||
26 | * Session logging and reloading. |
|
26 | * Session logging and reloading. | |
27 |
|
27 | |||
28 | * Extensible syntax processing for special purpose situations. |
|
28 | * Extensible syntax processing for special purpose situations. | |
29 |
|
29 | |||
30 | * Access to the system shell with user-extensible alias system. |
|
30 | * Access to the system shell with user-extensible alias system. | |
31 |
|
31 | |||
32 | * Easily embeddable in other Python programs and GUIs. |
|
32 | * Easily embeddable in other Python programs and GUIs. | |
33 |
|
33 | |||
34 | * Integrated access to the pdb debugger and the Python profiler. |
|
34 | * Integrated access to the pdb debugger and the Python profiler. | |
35 |
|
35 | |||
36 | The latest development version is always available from IPython's `GitHub |
|
36 | The latest development version is always available from IPython's `GitHub | |
37 | site <http://github.com/ipython>`_. |
|
37 | site <http://github.com/ipython>`_. |
General Comments 0
You need to be logged in to leave comments.
Login now