mirror of https://github.com/pypa/pip
Reorganize pip's docs folder
This commit is contained in:
parent
2b3609a37d
commit
d2e7377c0f
|
@ -1 +0,0 @@
|
||||||
# docs module
|
|
14
docs/conf.py
14
docs/conf.py
|
@ -18,10 +18,11 @@ import sys
|
||||||
|
|
||||||
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||||||
|
|
||||||
|
here = os.path.dirname(__file__)
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
sys.path.insert(0, os.path.abspath(os.pardir))
|
sys.path.insert(0, here)
|
||||||
# sys.path.append(os.path.join(os.path.dirname(__file__), '../'))
|
# sys.path.append(os.path.join(os.path.dirname(__file__), '../'))
|
||||||
|
|
||||||
# -- General configuration ----------------------------------------------------
|
# -- General configuration ----------------------------------------------------
|
||||||
|
@ -29,7 +30,7 @@ sys.path.insert(0, os.path.abspath(os.pardir))
|
||||||
# Add any Sphinx extension module names here, as strings. They can be
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
# extensions = ['sphinx.ext.autodoc']
|
# extensions = ['sphinx.ext.autodoc']
|
||||||
extensions = ['sphinx.ext.extlinks', 'docs.pipext', 'sphinx.ext.intersphinx']
|
extensions = ['sphinx.ext.extlinks', 'pip_sphinxext', 'sphinx.ext.intersphinx']
|
||||||
|
|
||||||
# intersphinx
|
# intersphinx
|
||||||
intersphinx_cache_limit = 0
|
intersphinx_cache_limit = 0
|
||||||
|
@ -68,9 +69,8 @@ version = release = 'dev'
|
||||||
# Rather than trying to force RTD to install pip properly, we'll simply
|
# Rather than trying to force RTD to install pip properly, we'll simply
|
||||||
# read the version direct from the __init__.py file. (Yes, this is
|
# read the version direct from the __init__.py file. (Yes, this is
|
||||||
# fragile, but it works...)
|
# fragile, but it works...)
|
||||||
root = os.path.dirname(os.path.dirname(__file__))
|
|
||||||
pip_init = os.path.join(root, 'src', 'pip', '__init__.py')
|
|
||||||
|
|
||||||
|
pip_init = os.path.join(here, '..', 'src', 'pip', '__init__.py')
|
||||||
with open(pip_init) as f:
|
with open(pip_init) as f:
|
||||||
for line in f:
|
for line in f:
|
||||||
m = re.match(r'__version__ = "(.*)"', line)
|
m = re.match(r'__version__ = "(.*)"', line)
|
||||||
|
@ -102,7 +102,7 @@ today_fmt = '%B %d, %Y'
|
||||||
|
|
||||||
# List of directories, relative to source directory, that shouldn't be searched
|
# List of directories, relative to source directory, that shouldn't be searched
|
||||||
# for source files.
|
# for source files.
|
||||||
exclude_patterns = ['build/', 'man/']
|
exclude_patterns = ['build/']
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all documents
|
# The reST default role (used for this markup: `text`) to use for all documents
|
||||||
# default_role = None
|
# default_role = None
|
||||||
|
@ -253,7 +253,7 @@ latex_documents = [
|
||||||
# List of manual pages generated
|
# List of manual pages generated
|
||||||
man_pages = [
|
man_pages = [
|
||||||
(
|
(
|
||||||
'man/pip',
|
'index',
|
||||||
'pip',
|
'pip',
|
||||||
u'package manager for Python packages',
|
u'package manager for Python packages',
|
||||||
u'pip developers',
|
u'pip developers',
|
||||||
|
@ -264,7 +264,7 @@ man_pages = [
|
||||||
# Here, we crawl the entire man/commands/ directory and list every file with
|
# Here, we crawl the entire man/commands/ directory and list every file with
|
||||||
# appropriate name and details
|
# appropriate name and details
|
||||||
for fname in glob.glob('man/commands/*.rst'):
|
for fname in glob.glob('man/commands/*.rst'):
|
||||||
fname_base = fname[:-4]
|
fname_base = fname[4:-4]
|
||||||
outname = 'pip-' + fname_base[13:]
|
outname = 'pip-' + fname_base[13:]
|
||||||
description = u'description of {} command'.format(
|
description = u'description of {} command'.format(
|
||||||
outname.replace('-', ' ')
|
outname.replace('-', ' ')
|
||||||
|
|
|
@ -3,4 +3,4 @@
|
||||||
Configuration
|
Configuration
|
||||||
=============
|
=============
|
||||||
|
|
||||||
This content is now covered in the :ref:`Configuration` section of the :doc:`User Guide <user_guide>`.
|
This content is now covered in the :ref:`Configuration` section of the :doc:`User Guide </user_guide>`.
|
|
@ -2,4 +2,4 @@
|
||||||
Release Notes
|
Release Notes
|
||||||
=============
|
=============
|
||||||
|
|
||||||
.. include:: ../NEWS.rst
|
.. include:: ../../NEWS.rst
|
8
tox.ini
8
tox.ini
|
@ -19,12 +19,12 @@ basepython = python3
|
||||||
commands = pytest --timeout 300 --cov=pip --cov-report=term-missing --cov-report=xml --cov-report=html tests/unit {posargs}
|
commands = pytest --timeout 300 --cov=pip --cov-report=term-missing --cov-report=xml --cov-report=html tests/unit {posargs}
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
# Don't skip install here since docs.pipext uses pip's internals.
|
# Don't skip install here since pip_sphinxext uses pip's internals.
|
||||||
deps = -r{toxinidir}/tools/docs-requirements.txt
|
deps = -r{toxinidir}/tools/docs-requirements.txt
|
||||||
basepython = python2.7
|
basepython = python3.6
|
||||||
commands =
|
commands =
|
||||||
sphinx-build -W -d {envtmpdir}/doctrees -b html docs docs/build/html
|
sphinx-build -W -c docs -d {envtmpdir}/doctrees/html -b html docs/html docs/build/html
|
||||||
sphinx-build -W -d {envtmpdir}/doctrees -b man docs docs/build/man
|
sphinx-build -W -c docs -d {envtmpdir}/doctrees/man -b man docs/man docs/build/man
|
||||||
|
|
||||||
[testenv:packaging]
|
[testenv:packaging]
|
||||||
skip_install = True
|
skip_install = True
|
||||||
|
|
Loading…
Reference in New Issue