##// END OF EJS Templates
upstream » ipython
RSS

Clone from https://github.com/ipython/ipython.git

Merge pull request #13746 from krassowski/docs-requirements...
Matthias Bussonnier -
r27783:270ac0cc merge
parent child Browse files
Show More
Show file before | Show file after | Hide comments
@@ -1,64 +1,64 b''
1 1 IPython Documentation
2 2 ---------------------
3 3
4 4 This directory contains the majority of the documentation for IPython.
5 5
6 6
7 7 Deploy docs
8 8 -----------
9 9
10 10 Documentation is automatically deployed on ReadTheDocs on every push or merged
11 11 Pull requests.
12 12
13 13
14 14 Requirements
15 15 ------------
16 16
17 17 The documentation must be built using Python 3.
18 18
19 19 In addition to :ref:`devinstall`,
20 20 the following tools are needed to build the documentation:
21 21
22 22 - sphinx
23 23 - sphinx_rtd_theme
24 24 - docrepr
25 25
26 26 In a conda environment, or a Python 3 ``venv``, you should be able to run::
27 27
28 28 cd ipython
29 pip install -U -r docs/requirements.txt
29 pip install .[doc] -U
30 30
31 31
32 32 Build Commands
33 33 --------------
34 34
35 35 The documentation gets built using ``make``, and comes in several flavors.
36 36
37 37 ``make html`` - build the API and narrative documentation web pages, this is
38 38 the default ``make`` target, so running just ``make`` is equivalent to ``make
39 39 html``.
40 40
41 41 ``make html_noapi`` - same as above, but without running the auto-generated API
42 42 docs. When you are working on the narrative documentation, the most time
43 43 consuming portion of the build process is the processing and rendering of the
44 44 API documentation. This build target skips that.
45 45
46 46 ``make pdf`` will compile a pdf from the documentation.
47 47
48 48 You can run ``make help`` to see information on all possible make targets.
49 49
50 50 To save time,
51 51 the make targets above only process the files that have been changed since the
52 52 previous docs build.
53 53 To remove the previous docs build you can use ``make clean``.
54 54 You can also combine ``clean`` with other `make` commands;
55 55 for example,
56 56 ``make clean html`` will do a complete rebuild of the docs or ``make clean pdf`` will do a complete build of the pdf.
57 57
58 58
59 59 Continuous Integration
60 60 ----------------------
61 61
62 62 Documentation builds are included in the Travis-CI continuous integration process,
63 63 so you can see the results of the docs build for any pull request at
64 64 https://travis-ci.org/ipython/ipython/pull_requests.
Show file before | Show file after | Hide comments
@@ -1,9 +1,1 b''
1 -e .[test]
2 ipykernel
3 setuptools>=18.5
4 sphinx
5 sphinx-rtd-theme
6 docrepr
7 matplotlib
8 stack_data
9 pytest<7
1 -e .[doc]
Show file before | Show file after | Hide comments
@@ -1,114 +1,122 b''
1 1 [metadata]
2 2 name = ipython
3 3 version = attr: IPython.core.release.__version__
4 4 url = https://ipython.org
5 5 description = IPython: Productive Interactive Computing
6 6 long_description_content_type = text/x-rst
7 7 long_description = file: long_description.rst
8 8 license_file = LICENSE
9 9 project_urls =
10 10 Documentation = https://ipython.readthedocs.io/
11 11 Funding = https://numfocus.org/
12 12 Source = https://github.com/ipython/ipython
13 13 Tracker = https://github.com/ipython/ipython/issues
14 14 keywords = Interactive, Interpreter, Shell, Embedding
15 15 platforms = Linux, Mac OSX, Windows
16 16 classifiers =
17 17 Framework :: IPython
18 18 Framework :: Jupyter
19 19 Intended Audience :: Developers
20 20 Intended Audience :: Science/Research
21 21 License :: OSI Approved :: BSD License
22 22 Programming Language :: Python
23 23 Programming Language :: Python :: 3
24 24 Programming Language :: Python :: 3 :: Only
25 25 Topic :: System :: Shells
26 26
27 27 [options]
28 28 packages = find:
29 29 python_requires = >=3.8
30 30 zip_safe = False
31 31 install_requires =
32 32 appnope; sys_platform == "darwin"
33 33 backcall
34 34 colorama; sys_platform == "win32"
35 35 decorator
36 36 jedi>=0.16
37 37 matplotlib-inline
38 38 pexpect>4.3; sys_platform != "win32"
39 39 pickleshare
40 40 prompt_toolkit>3.0.1,<3.1.0
41 41 pygments>=2.4.0
42 42 stack_data
43 43 traitlets>=5
44 44
45 45 [options.extras_require]
46 46 black =
47 47 black
48 48 doc =
49 Sphinx>=1.3
49 ipykernel
50 setuptools>=18.5
51 sphinx>=1.3
52 sphinx-rtd-theme
53 docrepr
54 matplotlib
55 stack_data
56 pytest<7
57 %(test)s
50 58 kernel =
51 59 ipykernel
52 60 nbconvert =
53 61 nbconvert
54 62 nbformat =
55 63 nbformat
56 64 notebook =
57 65 ipywidgets
58 66 notebook
59 67 parallel =
60 68 ipyparallel
61 69 qtconsole =
62 70 qtconsole
63 71 terminal =
64 72 test =
65 73 pytest<7.1
66 74 pytest-asyncio
67 75 testpath
68 76 test_extra =
69 77 %(test)s
70 78 curio
71 79 matplotlib!=3.2.0
72 80 nbformat
73 81 numpy>=1.19
74 82 pandas
75 83 trio
76 84 all =
77 85 %(black)s
78 86 %(doc)s
79 87 %(kernel)s
80 88 %(nbconvert)s
81 89 %(nbformat)s
82 90 %(notebook)s
83 91 %(parallel)s
84 92 %(qtconsole)s
85 93 %(terminal)s
86 94 %(test_extra)s
87 95 %(test)s
88 96
89 97 [options.packages.find]
90 98 exclude =
91 99 setupext
92 100
93 101 [options.package_data]
94 102 IPython.core = profile/README*
95 103 IPython.core.tests = *.png, *.jpg, daft_extension/*.py
96 104 IPython.lib.tests = *.wav
97 105 IPython.testing.plugin = *.txt
98 106
99 107 [options.entry_points]
100 108 console_scripts =
101 109 ipython = IPython:start_ipython
102 110 ipython3 = IPython:start_ipython
103 111 pygments.lexers =
104 112 ipythonconsole = IPython.lib.lexers:IPythonConsoleLexer
105 113 ipython = IPython.lib.lexers:IPythonLexer
106 114 ipython3 = IPython.lib.lexers:IPython3Lexer
107 115
108 116 [velin]
109 117 ignore_patterns =
110 118 IPython/core/tests
111 119 IPython/testing
112 120
113 121 [tool.black]
114 122 exclude = 'timing\.py'
General Comments 0
You need to be logged in to leave comments. Login now