IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

apidoc: Deprecate unused functions

Browse Source
This commit is contained in:
Takeshi KOMIYA 2019-05-04 17:26:26 +09:00
parent b93f53c7e4
commit fa560ebf95
3 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -41,6 +41,8 @@ Deprecated
* ``sphinx.domains.std.StandardDomain.note_citation_refs()`` * ``sphinx.domains.std.StandardDomain.note_citation_refs()``
* ``sphinx.domains.std.StandardDomain.note_labels()`` * ``sphinx.domains.std.StandardDomain.note_labels()``
* ``sphinx.environment.NoUri`` * ``sphinx.environment.NoUri``
* ``sphinx.ext.apidoc.format_directive()``
* ``sphinx.ext.apidoc.format_heading()``
* ``sphinx.ext.autodoc.importer.MockFinder`` * ``sphinx.ext.autodoc.importer.MockFinder``
* ``sphinx.ext.autodoc.importer.MockLoader`` * ``sphinx.ext.autodoc.importer.MockLoader``
* ``sphinx.ext.autodoc.importer.mock()`` * ``sphinx.ext.autodoc.importer.mock()``

9
doc/extdev/deprecated.rst
View File

@ -161,6 +161,15 @@ The following is a list of deprecated interfaces.
- 2.1 - 2.1
- 4.0 - 4.0
- ``sphinx.errors.NoUri`` - ``sphinx.errors.NoUri``
* - ``sphinx.ext.apidoc.format_directive()``
- 2.1
- 4.0
- N/A
* - ``sphinx.ext.apidoc.format_heading()``
- 2.1
- 4.0
- N/A
* - ``sphinx.ext.autodoc.importer.MockFinder`` * - ``sphinx.ext.autodoc.importer.MockFinder``
- 2.1 - 2.1

6
sphinx/ext/apidoc.py
View File

@ -19,12 +19,14 @@ import glob
import locale import locale
import os import os
import sys import sys
import warnings
from fnmatch import fnmatch from fnmatch import fnmatch
from os import path from os import path
import sphinx.locale import sphinx.locale
from sphinx import __display_version__, package_dir from sphinx import __display_version__, package_dir
from sphinx.cmd.quickstart import EXTENSIONS from sphinx.cmd.quickstart import EXTENSIONS
from sphinx.deprecation import RemovedInSphinx40Warning
from sphinx.locale import __ from sphinx.locale import __
from sphinx.util import rst from sphinx.util import rst
from sphinx.util.osutil import FileAvoidWrite, ensuredir from sphinx.util.osutil import FileAvoidWrite, ensuredir
@ -82,6 +84,8 @@ def write_file(name, text, opts):
def format_heading(level, text, escape=True): def format_heading(level, text, escape=True):
# type: (int, str, bool) -> str # type: (int, str, bool) -> str
"""Create a heading of <level> [1, 2 or 3 supported].""" """Create a heading of <level> [1, 2 or 3 supported]."""
warnings.warn('format_warning() is deprecated.',
RemovedInSphinx40Warning)
if escape: if escape:
text = rst.escape(text) text = rst.escape(text)
underlining = ['=', '-', '~', ][level - 1] * len(text) underlining = ['=', '-', '~', ][level - 1] * len(text)
@ -91,6 +95,8 @@ def format_heading(level, text, escape=True):
def format_directive(module, package=None): def format_directive(module, package=None):
# type: (str, str) -> str # type: (str, str) -> str
"""Create the automodule directive and add the options.""" """Create the automodule directive and add the options."""
warnings.warn('format_directive() is deprecated.',
RemovedInSphinx40Warning)
directive = '.. automodule:: %s\n' % makename(package, module) directive = '.. automodule:: %s\n' % makename(package, module)
for option in OPTIONS: for option in OPTIONS:
directive += ' :%s:\n' % option directive += ' :%s:\n' % option