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
12,345 Commits 2 Branches 219 Tags 163 MiB
0f972e8bbf
Commit Graph

249 Commits

Author SHA1 Message Date
Takeshi KOMIYA
0f972e8bbf The arguments of EpubBuilder.build_mimetype() is deprecated 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
39c0380c4d refactor: deprecate some pycompat functions 2019-01-07 22:54:37 +09:00
Takeshi KOMIYA
353c3e9fd6
Merge pull request #5415 from tk0miya/5410_replace_open_file_by_open 
refactor: Repalce HTMLHelpBuilder.open_file() by standard open()
 2019-01-07 00:59:03 +09:00
Takeshi KOMIYA
56f4b27faa Deprecate LaTeXTranslator.generate_numfig_format() 2019-01-04 23:06:34 +09:00
Takeshi KOMIYA
45d04703fe latex: Move ExtBabel to sphinx.builders.latex.util package 2019-01-04 23:06:34 +09:00
Takeshi KOMIYA
3c7b4e77e0 refactor: Repalce HTMLHelpBuilder.open_file() by standard open() 2019-01-03 02:05:32 +09:00
jfbu
b62bf0e0fc Redo spelling fix lost in merge (contents moved to other file) 
modified:   doc/extdev/index.rst
 2018-12-28 16:03:26 +01:00
jfbu
32d57b8637 Merge branch '1.8' 
resolved Conflicts:
	doc/development/tutorials/todo.rst
	sphinx/locale/__init__.py
	sphinx/search/zh.py
 2018-12-28 12:50:20 +01:00
jfbu
1e07cb10fc Fix various spelling typos 2018-12-27 13:06:33 +01:00
Takeshi KOMIYA
55a89196e4
Merge pull request #5678 from ArtFlag/docs/extension-tutorials 
Docs: Extension tutorial portal + helloworld example
 2018-12-23 22:55:24 +09:00
ArtFlag
35b62e21c9 Move content from the todo tutorial to the extdev/index 2018-12-22 11:38:12 +01:00
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
ArtFlag
870e2bbc1c move files to new directory 2018-12-19 17:35:17 +01: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:

5c69373890/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
Arthur
adc1d2b59d
Merge branch 'master' into docs/extension-tutorials 2018-11-30 10:33:20 +01:00
Takeshi KOMIYA
f7317651a1 Refactor sphinx.search 2018-11-30 18:03:20 +09:00
ArtFlag
8479876798 Add a helloworld tutorial 2018-11-29 00:14:31 +01:00
ArtFlag
83e9e1378c Create a tutorial portal 2018-11-28 17:27:12 +01: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