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