mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge branch '3.x' into 8105_incorrect_class_constructor
This commit is contained in:
commit
1955a08378
16
.github/workflows/main.yml
vendored
16
.github/workflows/main.yml
vendored
@ -8,7 +8,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
name: [py35, py36, py37]
|
name: [py35, py36, py37, py38, py39]
|
||||||
include:
|
include:
|
||||||
- name: py35
|
- name: py35
|
||||||
python: 3.5
|
python: 3.5
|
||||||
@ -19,6 +19,15 @@ jobs:
|
|||||||
- name: py37
|
- name: py37
|
||||||
python: 3.7
|
python: 3.7
|
||||||
docutils: du14
|
docutils: du14
|
||||||
|
- name: py38
|
||||||
|
python: 3.8
|
||||||
|
docutils: du15
|
||||||
|
- name: py39
|
||||||
|
python: 3.9
|
||||||
|
docutils: du16
|
||||||
|
coverage: "--cov ./ --cov-append --cov-config setup.cfg"
|
||||||
|
env:
|
||||||
|
PYTEST_ADDOPTS: ${{ matrix.coverage }}
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
@ -31,9 +40,12 @@ jobs:
|
|||||||
- name: Install graphviz
|
- name: Install graphviz
|
||||||
run: sudo apt-get install graphviz
|
run: sudo apt-get install graphviz
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pip install -U tox
|
run: pip install -U tox codecov
|
||||||
- name: Run Tox
|
- name: Run Tox
|
||||||
run: tox -e ${{ matrix.docutils }} -- -vv
|
run: tox -e ${{ matrix.docutils }} -- -vv
|
||||||
|
- name: codecov
|
||||||
|
uses: codecov/codecov-action@v1
|
||||||
|
if: matrix.coverage
|
||||||
|
|
||||||
windows:
|
windows:
|
||||||
runs-on: windows-latest
|
runs-on: windows-latest
|
||||||
|
21
.github/workflows/nodejs.yml
vendored
Normal file
21
.github/workflows/nodejs.yml
vendored
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
name: CI (node.js)
|
||||||
|
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
env:
|
||||||
|
node-version: 10.7
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Use Node.js ${{ env.node-version }}
|
||||||
|
uses: actions/setup-node@v1
|
||||||
|
with:
|
||||||
|
node-version: ${{ env.node-version }}
|
||||||
|
- run: npm install
|
||||||
|
- name: Run headless test
|
||||||
|
uses: GabrielBB/xvfb-action@v1
|
||||||
|
with:
|
||||||
|
run: npm test
|
34
.travis.yml
34
.travis.yml
@ -1,34 +0,0 @@
|
|||||||
os: linux
|
|
||||||
dist: xenial
|
|
||||||
language: python
|
|
||||||
cache: pip
|
|
||||||
|
|
||||||
env:
|
|
||||||
global:
|
|
||||||
- PYTHONFAULTHANDLER=x
|
|
||||||
- SKIP_LATEX_BUILD=1
|
|
||||||
- IS_PYTHON=true
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
include:
|
|
||||||
- python: '3.8'
|
|
||||||
env:
|
|
||||||
- TOXENV=du15
|
|
||||||
- PYTEST_ADDOPTS="--cov ./ --cov-append --cov-config setup.cfg"
|
|
||||||
|
|
||||||
- language: node_js
|
|
||||||
node_js: '10.7'
|
|
||||||
env: IS_PYTHON=false
|
|
||||||
services: xvfb
|
|
||||||
|
|
||||||
install:
|
|
||||||
- "sudo apt-get install graphviz"
|
|
||||||
- if [ $IS_PYTHON = true ]; then pip install -U tox codecov; fi
|
|
||||||
- if [ $IS_PYTHON = false ]; then npm install; fi
|
|
||||||
|
|
||||||
script:
|
|
||||||
- if [ $IS_PYTHON = true ]; then tox -- -vv; fi
|
|
||||||
- if [ $IS_PYTHON = false ]; then npm test; fi
|
|
||||||
|
|
||||||
after_success:
|
|
||||||
- if [[ -e .coverage ]]; then codecov -e $TOXENV; fi
|
|
1
CHANGES
1
CHANGES
@ -26,6 +26,7 @@ Bugs fixed
|
|||||||
----------
|
----------
|
||||||
|
|
||||||
* #7613: autodoc: autodoc does not respect __signature__ of the class
|
* #7613: autodoc: autodoc does not respect __signature__ of the class
|
||||||
|
* #4606: autodoc: the location of the warning is incorrect for inherited method
|
||||||
* #8105: autodoc: the signature of class constructor is incorrect if the class
|
* #8105: autodoc: the signature of class constructor is incorrect if the class
|
||||||
is decorated
|
is decorated
|
||||||
|
|
||||||
|
@ -272,9 +272,9 @@ identifier and put ``sphinx.po`` in there. Don't forget to update the possible
|
|||||||
values for :confval:`language` in ``doc/usage/configuration.rst``.
|
values for :confval:`language` in ``doc/usage/configuration.rst``.
|
||||||
|
|
||||||
The Sphinx core messages can also be translated on `Transifex
|
The Sphinx core messages can also be translated on `Transifex
|
||||||
<https://www.transifex.com/sphinx-doc/>`_. There ``tx`` client tool, which is
|
<https://www.transifex.com/sphinx-doc/sphinx-1/>`_. There ``tx`` client tool,
|
||||||
provided by the ``transifex_client`` Python package, can be used to pull
|
which is provided by the ``transifex_client`` Python package, can be used to
|
||||||
translations in ``.po`` format from Transifex. To do this, go to
|
pull translations in ``.po`` format from Transifex. To do this, go to
|
||||||
``sphinx/locale`` and then run ``tx pull -f -l LANG`` where ``LANG`` is an
|
``sphinx/locale`` and then run ``tx pull -f -l LANG`` where ``LANG`` is an
|
||||||
existing language identifier. It is good practice to run ``python setup.py
|
existing language identifier. It is good practice to run ``python setup.py
|
||||||
update_catalog`` afterwards to make sure the ``.po`` file has the canonical
|
update_catalog`` afterwards to make sure the ``.po`` file has the canonical
|
||||||
|
1
setup.py
1
setup.py
@ -203,6 +203,7 @@ setup(
|
|||||||
'Programming Language :: Python :: 3.6',
|
'Programming Language :: Python :: 3.6',
|
||||||
'Programming Language :: Python :: 3.7',
|
'Programming Language :: Python :: 3.7',
|
||||||
'Programming Language :: Python :: 3.8',
|
'Programming Language :: Python :: 3.8',
|
||||||
|
'Programming Language :: Python :: 3.9',
|
||||||
'Programming Language :: Python :: Implementation :: CPython',
|
'Programming Language :: Python :: Implementation :: CPython',
|
||||||
'Programming Language :: Python :: Implementation :: PyPy',
|
'Programming Language :: Python :: Implementation :: PyPy',
|
||||||
'Framework :: Setuptools Plugin',
|
'Framework :: Setuptools Plugin',
|
||||||
|
@ -543,9 +543,18 @@ class Documenter:
|
|||||||
yield from docstringlines
|
yield from docstringlines
|
||||||
|
|
||||||
def get_sourcename(self) -> str:
|
def get_sourcename(self) -> str:
|
||||||
|
if (getattr(self.object, '__module__', None) and
|
||||||
|
getattr(self.object, '__qualname__', None)):
|
||||||
|
# Get the correct location of docstring from self.object
|
||||||
|
# to support inherited methods
|
||||||
|
fullname = '%s.%s' % (self.object.__module__, self.object.__qualname__)
|
||||||
|
else:
|
||||||
|
fullname = self.fullname
|
||||||
|
|
||||||
if self.analyzer:
|
if self.analyzer:
|
||||||
return '%s:docstring of %s' % (self.analyzer.srcname, self.fullname)
|
return '%s:docstring of %s' % (self.analyzer.srcname, fullname)
|
||||||
return 'docstring of %s' % self.fullname
|
else:
|
||||||
|
return 'docstring of %s' % fullname
|
||||||
|
|
||||||
def add_content(self, more_content: Any, no_docstring: bool = False) -> None:
|
def add_content(self, more_content: Any, no_docstring: bool = False) -> None:
|
||||||
"""Add content from docstrings, attribute documentation and user."""
|
"""Add content from docstrings, attribute documentation and user."""
|
||||||
|
@ -62,14 +62,6 @@ def getargspec(func: Callable) -> Any:
|
|||||||
methods."""
|
methods."""
|
||||||
warnings.warn('sphinx.ext.inspect.getargspec() is deprecated',
|
warnings.warn('sphinx.ext.inspect.getargspec() is deprecated',
|
||||||
RemovedInSphinx50Warning, stacklevel=2)
|
RemovedInSphinx50Warning, stacklevel=2)
|
||||||
# On 3.5+, signature(int) or similar raises ValueError. On 3.4, it
|
|
||||||
# succeeds with a bogus signature. We want a TypeError uniformly, to
|
|
||||||
# match historical behavior.
|
|
||||||
if (isinstance(func, type) and
|
|
||||||
is_builtin_class_method(func, "__new__") and
|
|
||||||
is_builtin_class_method(func, "__init__")):
|
|
||||||
raise TypeError(
|
|
||||||
"can't compute signature for built-in type {}".format(func))
|
|
||||||
|
|
||||||
sig = inspect.signature(func)
|
sig = inspect.signature(func)
|
||||||
|
|
||||||
|
2
tox.ini
2
tox.ini
@ -26,7 +26,7 @@ extras =
|
|||||||
test
|
test
|
||||||
setenv =
|
setenv =
|
||||||
PYTHONWARNINGS = all,ignore::ImportWarning:importlib._bootstrap_external,ignore::DeprecationWarning:site,ignore::DeprecationWarning:distutils
|
PYTHONWARNINGS = all,ignore::ImportWarning:importlib._bootstrap_external,ignore::DeprecationWarning:site,ignore::DeprecationWarning:distutils
|
||||||
PYTEST_ADDOPTS = --color yes
|
PYTEST_ADDOPTS = {env:PYTEST_ADDOPTS:} --color yes
|
||||||
commands=
|
commands=
|
||||||
pytest --durations 25 {posargs}
|
pytest --durations 25 {posargs}
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user