Merge pull request #13746 from krassowski/docs-requirements

Move documentation requirements to setup.cfg

docs/README.rst

@@ -1,64 +1,64 b''
 IPython Documentation
 ---------------------
 
 This directory contains the majority of the documentation for IPython.
 
 
 Deploy docs
 -----------
 
 Documentation is automatically deployed on ReadTheDocs on every push or merged
 Pull requests.
 
 
 Requirements
 ------------
 
 The documentation must be built using Python 3.
 
 In addition to :ref:`devinstall`,
 the following tools are needed to build the documentation:
 
  - sphinx
  - sphinx_rtd_theme
  - docrepr
 
 In a conda environment, or a Python 3 ``venv``, you should be able to run::
 
   cd ipython
-  pip install -U -r docs/requirements.txt
+  pip install .[doc] -U
 
 
 Build Commands
 --------------
 
 The documentation gets built using ``make``, and comes in several flavors.
 
 ``make html`` - build the API and narrative documentation web pages, this is
 the default ``make`` target, so running just ``make`` is equivalent to ``make
 html``.
 
 ``make html_noapi`` - same as above, but without running the auto-generated API
 docs. When you are working on the narrative documentation, the most time
 consuming portion  of the build process is the processing and rendering of the
 API documentation. This build target skips that.
 
 ``make pdf`` will compile a pdf from the documentation.
 
 You can run ``make help`` to see information on all possible make targets.
 
 To save time,
 the make targets above only process the files that have been changed since the
 previous docs build.
 To remove the previous docs build you can use ``make clean``.
 You can also combine ``clean`` with other `make` commands;
 for example,
 ``make clean html`` will do a complete rebuild of the docs or ``make clean pdf`` will do a complete build of the pdf.
 
 
 Continuous Integration
 ----------------------
 
 Documentation builds are included in the Travis-CI continuous integration process,
 so you can see the results of the docs build for any pull request at
 https://travis-ci.org/ipython/ipython/pull_requests.

docs/requirements.txt

@@ -1,9 +1,1 b''
--e .[test]
-ipykernel
-setuptools>=18.5
-sphinx
-sphinx-rtd-theme
-docrepr
-matplotlib
-stack_data
-pytest<7
+-e .[doc]

setup.cfg

@@ -1,114 +1,122 b''
 [metadata]
 name = ipython
 version = attr: IPython.core.release.__version__
 url = https://ipython.org
 description = IPython: Productive Interactive Computing
 long_description_content_type = text/x-rst
 long_description = file: long_description.rst
 license_file = LICENSE
 project_urls =
     Documentation = https://ipython.readthedocs.io/
     Funding = https://numfocus.org/
     Source = https://github.com/ipython/ipython
     Tracker = https://github.com/ipython/ipython/issues
 keywords = Interactive, Interpreter, Shell, Embedding
 platforms = Linux, Mac OSX, Windows
 classifiers =
     Framework :: IPython
     Framework :: Jupyter
     Intended Audience :: Developers
     Intended Audience :: Science/Research
     License :: OSI Approved :: BSD License
     Programming Language :: Python
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3 :: Only
     Topic :: System :: Shells
 
 [options]
 packages = find:
 python_requires = >=3.8
 zip_safe = False
 install_requires =
     appnope; sys_platform == "darwin"
     backcall
     colorama; sys_platform == "win32"
     decorator
     jedi>=0.16
     matplotlib-inline
     pexpect>4.3; sys_platform != "win32"
     pickleshare
     prompt_toolkit>3.0.1,<3.1.0
     pygments>=2.4.0
     stack_data
     traitlets>=5
 
 [options.extras_require]
 black =
     black
 doc =
-    Sphinx>=1.3
+    ipykernel
+    setuptools>=18.5
+    sphinx>=1.3
+    sphinx-rtd-theme
+    docrepr
+    matplotlib
+    stack_data
+    pytest<7
+    %(test)s
 kernel =
     ipykernel
 nbconvert =
     nbconvert
 nbformat =
     nbformat
 notebook =
     ipywidgets
     notebook
 parallel =
     ipyparallel
 qtconsole =
     qtconsole
 terminal =
 test =
     pytest<7.1
     pytest-asyncio
     testpath
 test_extra =
     %(test)s
     curio
     matplotlib!=3.2.0
     nbformat
     numpy>=1.19
     pandas
     trio
 all =
     %(black)s
     %(doc)s
     %(kernel)s
     %(nbconvert)s
     %(nbformat)s
     %(notebook)s
     %(parallel)s
     %(qtconsole)s
     %(terminal)s
     %(test_extra)s
     %(test)s
 
 [options.packages.find]
 exclude =
     setupext
 
 [options.package_data]
 IPython.core = profile/README*
 IPython.core.tests = *.png, *.jpg, daft_extension/*.py
 IPython.lib.tests = *.wav
 IPython.testing.plugin = *.txt
 
 [options.entry_points]
 console_scripts =
     ipython = IPython:start_ipython
     ipython3 = IPython:start_ipython
 pygments.lexers =
     ipythonconsole = IPython.lib.lexers:IPythonConsoleLexer
     ipython = IPython.lib.lexers:IPythonLexer
     ipython3 = IPython.lib.lexers:IPython3Lexer
 
 [velin]
 ignore_patterns =
    IPython/core/tests
    IPython/testing
 
 [tool.black]
 exclude = 'timing\.py'