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,602 Commits 2 Branches 219 Tags
2efc1065c0dcd49e10973cc47cd1b569accd3b21
Commit Graph

2342 Commits

Author SHA1 Message Date
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
f811e4cea6 Merge pull request #5859 from tk0miya/fix_doc_for_viewcode_follow_imported_members 
doc: Fix description for viewcode_follow_imported_members
 2018-12-26 01:26:52 +09:00
Takeshi KOMIYA
b229c1a672 Merge pull request #5224 from TimKam/5216-update-markdown-doc 
#5216 update Markdown config doc to API changes
 2018-12-24 12:27:26 +09:00
Timotheus Kampik
3addad5f2a Merge branch 'master' into 5216-update-markdown-doc 2018-12-23 17:31:01 +01:00
Timotheus Kampik
90181a16ed #5216 fix removal note 2018-12-23 17:28:44 +01:00
Timotheus Kampik
9583290653 #5216 add note regarding recommonmark version 2018-12-23 17:27:54 +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
Takeshi KOMIYA
5b2befe97d doc: Fix description for viewcode_follow_imported_members 2018-12-23 22:13:33 +09:00
Jon Dufresne
4e184754c9 Remove instructions to install Python 2 on Windows 
As only Python 3 is supported, should not advise users to install Python
2.
 2018-12-23 04:00:26 -08:00
ArtFlag
17a15ef145 Fix build issues 2018-12-23 12:26:30 +01:00
jfbu
d4d1a4ba84 Merge branch 'master' into latex_tableofcontentshook 2018-12-23 11:31:10 +01:00
jfbu
701b39328f Merge branch '1.8' 
(Resolved) Conflicts:
	sphinx/texinputs/sphinxmanual.cls
 2018-12-23 11:23:04 +01:00
Timotheus Kampik
20c9489828 #5216 change recommonmark installation instruction 
the pypi package has not been updated since January 2016;
it is better to install from source
 2018-12-23 10:43:39 +01:00
jfbu
8e14532b08 LaTeX: move some hard-coded re-definitions to user hook for TOC 2018-12-22 17:33:03 +01:00
ArtFlag
35b62e21c9 Move content from the todo tutorial to the extdev/index 2018-12-22 11:38:12 +01:00
ArtFlag
a85f8e2305 Minor changes in helloworld 2018-12-22 11:13:35 +01:00
jfbu
1920d1d950 LaTeX: `\sphinxmaketitle and optional \sphinxbackoftitlepage` 
Closes: #5849
 2018-12-21 21:38:27 +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
Jean-François B
696c8f0fc0 Merge pull request #5693 from jfbu/latex_doc_unicode_in_math 
LaTeX (doc): explain how to allow Unicode input in math
 2018-12-20 20:31:31 +01:00
jfbu
fdb6147555 LaTeX (doc): explain how to allow Unicode input in math 
Closes: #5249
 2018-12-20 19:43:50 +01:00
Takeshi KOMIYA
914e655960 Merge pull request #5664 from tk0miya/refactor_latex3 
refactor: Initialize template variables for LaTeX in builder; date, logofilename and packages
 2018-12-20 11:13:47 +09:00
Takeshi KOMIYA
6fe57436a8 Merge pull request #5839 from jdufresne/description 
Deprecate unused Exception attributes
 2018-12-20 10:15:06 +09:00
ArtFlag
990b02b5fb Feedback 2018-12-19 17:35:17 +01: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
a1976cc0c8 Update docs 2018-12-19 01:32:26 +09: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
d8b69c7f98 Merge pull request #5819 from jdufresne/coding-comment 
Remove unnecessary encoding cookie from Python source files
 2018-12-17 19:15:00 +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
bade33c7e4 Remove unnecessary encoding cookie from Python source files 
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:

https://docs.python.org/3/howto/unicode.html#the-string-type

> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...

Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
 2018-12-16 12:22:12 -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
Jean-François B
6395c7d242 Merge pull request #5790 from jfbu/latex_turnoff_lualatex_ligatures 
Latex turnoff lualatex ligatures
 2018-12-16 11:00:26 +01: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
jfbu
7364e0c2fd Update docs for LuaLaTeX 2018-12-15 15:16:43 +01:00
Takeshi KOMIYA
6b24c069c3 Deprecate sphinx.util.inspect.Parameter 2018-12-15 21:44:17 +09:00
Takeshi KOMIYA
a1e845d964 Merge pull request #5777 from tk0miya/5720_deprecate_abbreviation_node 
Deprecate abbreviation node (refs: #5720)
 2018-12-15 20:58:54 +09:00
Takeshi KOMIYA
08bc847964 Deprecate abbreviation node (refs: #5720) 2018-12-15 20:13:04 +09:00
Jean-François B
661fb1de59 LaTeX: use Bjarne option of fncychap also if language is set to 'en' (#5776) 
Closes: #5772
 2018-12-15 11:37:56 +01:00