Commit Graph
234 Commits
Author SHA1 Message Date
jfbu f8389f5181 [DOC] Make link to list of deprecated APIs in CHANGES an internal link 2018-12-20 21:18:37 +01:00
Takeshi KOMIYA 6fe57436a8 Merge pull request #5839 from jdufresne/description
Deprecate unused Exception attributes
2018-12-20 10:15:06 +09:00
Takeshi KOMIYA d0f5862597 Replace EnvironmentError and IOError by OSError
Since python 3.3, EnvironmentError and IOError were merged into
OSError.
2018-12-19 19:26:50 +09:00
Jon Dufresne e9eaf41a58 Deprecate unused Exception attributes
The attributes were used only for the string representation, but that is
also the default behavior of the Exception class. Observe:

>>> str(Exception('foo'))
'foo'
>>> print(Exception('foo'))
foo
2018-12-18 18:32:16 -08:00
Takeshi KOMIYA 9574607578 Merge pull request #5827 from tk0miya/refactor_io3
Refactor sphinx.io
2018-12-18 23:28:50 +09:00
Jon Dufresne 43ff640b58 Deprecate quickstart.term_decode() and remove internal uses
Per the Python 3 docs, input() always returns a string:

https://docs.python.org/3/library/functions.html#input

> The function then reads a line from input, converts it to a
> string (stripping a trailing newline), and returns that.

The stubs from typeshed say the same:

https://github.com/python/typeshed/blob/5c69373890dfaf4f07f0638766fb0a4903352892/stdlib/3/builtins.pyi#L835

Here is the implementation from CPython with also shows a call to
PyUnicode_Decode on the result:

https://github.com/python/cpython/blob/3.7/Python/bltinmodule.c#L1960-L2143

As the value is always a string, there is nothing to decode. Therefore
the call to term_decode() unnecessary and can safely be removed.

With this in mind, must adjust quickstart tests to be more
representative.
2018-12-17 06:44:17 -08:00
Takeshi KOMIYA f3350b8b7d Deprecate SphinxFileInput.supported 2018-12-17 22:26:29 +09:00
Takeshi KOMIYA 636ca67528 Deprecate SphinxBaseFileInput 2018-12-17 22:08:00 +09:00
Takeshi KOMIYA de49b991f6 refactor: Use simple Input class 2018-12-17 22:07:56 +09:00
Takeshi KOMIYA 71a7ce1453 Merge branch 'master' into string-classes 2018-12-17 18:58:32 +09:00
Jon Dufresne c4baa7234e Deprecate the old IndexBuilder.feed() method signature
The method signature changed in commit
d27386cc95 (Jun 8, 2016).
2018-12-16 13:52:56 -08:00
Jon Dufresne 80861d105b Deprecate sphinx.config.string_classes; remove all internal uses
With only a single text type across supported Python versions, the
string_classes is no longer necessary.

Internally, all uses were converted to the value `[str]`. For
.add_config_value() uses that also supply a default string, the type is
inferred.
2018-12-16 11:35:06 -08:00
Takeshi KOMIYA 6461ea233b Merge pull request #5793 from tk0miya/pretty_changes
Pretty changes
2018-12-16 23:13:37 +09:00
Takeshi KOMIYA 1bf9a7eac5 Deprecate LaTeXTranslator.collect_footnotes() 2018-12-16 21:52:30 +09:00
Takeshi KOMIYA cdb36fbbf6 Sort deprecated APIs by version 2018-12-16 21:51:33 +09:00
Takeshi KOMIYA 048cfb5e0a Deprecate UnicodeMixin 2018-12-16 21:51:18 +09:00
Jon Dufresne 49d3a3c0c1 Replace ENOENT errno checks with Python 3 FileNotFoundError
The error is more specific and self documenting.

This removes the last use of sphinx.util.osutil.ENOENT, so it is now
deprecated for removal. sphinx.util.osutil.EEXIST was already unused so
that is deprecated as well.
2018-12-15 09:02:55 -08:00
Takeshi KOMIYA 6b24c069c3 Deprecate sphinx.util.inspect.Parameter 2018-12-15 21:44:17 +09:00
Takeshi KOMIYA 08bc847964 Deprecate abbreviation node (refs: #5720) 2018-12-15 20:13:04 +09:00
Takeshi KOMIYA d898da697d Refactor Autosummary directive by DocumenterBridge 2018-12-10 22:36:44 +09:00
Jon Dufresne 3a96ce6591 Deprecate unused and untested sphinx.util functions
sphinx.util.attrdict: Last use removed in
b09e628b0f.

sphinx.util.PeekableIterator: Last use removed in
85b8a451a6.
2018-12-09 14:54:50 -08:00
Takeshi KOMIYA c8ce761a73 deprecate SphinxRSTFileInput 2018-12-05 23:11:16 +09:00
Takeshi KOMIYA 1a50d34520 refactor `mock()` to based on PEP-451 implementation 2018-12-04 23:57:01 +09:00
Takeshi KOMIYA b837a5aec0 refactor TexinfoTranslator; Replace _make_visit_admonition() 2018-12-04 01:40:15 +09:00
Takeshi KOMIYA f5b7d24003 refactor LaTeXTranslator; Replace _make_visit_admonition() 2018-12-04 01:40:14 +09:00
Takeshi KOMIYA 97615beda2 refactor TextTranslator; Replace _make_depart_admonition() 2018-12-04 01:40:14 +09:00
Takeshi KOMIYA f7317651a1 Refactor sphinx.search 2018-11-30 18:03:20 +09:00
Jon Dufresne 555960d668 Deprecate and drop internal use of force_decode()
In the Python 3 only code base, this function is no longer necessary.
The type of values is well understood and deliberate. Code should avoid
arbitrary mixing of bytes & str.

By removing force_decode() calls from docstring values, can deprecate
the now unused 'encoding' arguments to various autodoc methods.
2018-11-13 07:16:39 -08:00
Jon Dufresne 6fbf4a2f99 Deprecate sphinx.util.pycompat.u
It is now simply a constant equal to the empty string. Provides no
further utility.
2018-11-12 16:31:27 -08:00
Jon Dufresne 27a6787d63 Remove use of six.binary_type
Remove type checks for cases that don't apply to Python 3.

For remaining uses, use bytes instead
2018-11-11 19:09:47 -08:00
Takeshi KOMIYA dcc4ac55bb latex: Move \pageautorefname to sphinxmessages.sty 2018-11-01 22:47:15 +09:00
Takeshi KOMIYA ca8bc8ca49 refactor: Deprecate app._setting_up_extension 2018-10-17 11:56:11 +09:00
Takeshi KOMIYA 4ed5c51cff logging: Add prefixed_warnings() helper 2018-10-17 11:21:22 +09:00
Takeshi KOMIYA 491d0406df Deprecate get_matching_docs() 2018-10-16 10:34:59 +09:00
Takeshi KOMIYA eaec3bd916 Add sphinx.project; a manipulator for project and documents 2018-10-16 10:34:58 +09:00
Takeshi KOMIYA e7e07fd697 Merge branch '1.8' 2018-10-16 09:57:54 +09:00
Jon Dufresne 05ac246eff Deprecate Python2 compat shim sphinx.util.osutil.walk()
Code should use os.walk() instead, which works with either str or bytes.
All internal calls use str.
2018-10-05 12:39:50 -07:00
Takeshi KOMIYA 0e4c23fc35 Deprecate string style base for env.doc2path() 2018-09-22 23:22:11 +09:00
Takeshi KOMIYA 8bd2f921f9 Deprecate suffix for env.doc2path() 2018-09-22 23:21:34 +09:00
Takeshi KOMIYA 3a2418a827 refactoring: Drop PY2 and PY3 flags 2018-09-22 21:27:59 +09:00
jfbu 6f08c09ecb Improve Table of Deprecated APIs for LaTeX output (docs) 2018-09-22 11:44:04 +02:00
Takeshi KOMIYA 98648325aa Merge branch '1.8' 2018-09-22 17:16:24 +09:00
Takeshi KOMIYA ae12f357c7 Fix #5463: mathbase: math_role and MathDirective was disappeared in 1.8.0 2018-09-21 23:44:11 +09:00
Takeshi KOMIYA efdc95ef8b Merge branch '1.8' 2018-09-13 00:53:09 +09:00
Takeshi KOMIYA b2b833d39e Update CHANGES for PR #5403 2018-09-10 20:45:16 +09:00
Takeshi KOMIYA 02afc357ef Merge branch '1.8' 2018-09-09 19:26:48 +09:00
Takeshi KOMIYA 8e729b419e Fix #5399: Sphinx crashes if unknown po file exists 2018-09-08 22:21:59 +09:00
Takeshi KOMIYA a7cab001d9 Drop APIs deprecated in 2.0 2018-09-03 00:31:33 +09:00
Takeshi KOMIYA 864ded3d8a Merge pull request #5343 from tk0miya/5340_update_docs
docs: Fix wrong descriptions for logging APIs
2018-08-26 11:30:51 +09:00
Takeshi KOMIYA 0a485740a8 docs: Fix wrong descriptions for logging APIs 2018-08-25 10:59:04 +09:00