Commit Graph

2249 Commits

Author SHA1 Message Date
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
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
jfbu
022fc9d3b6 LaTeX: use `\small` fontsize in code-blocks with xelatex and lualatex 2018-12-13 15:00:38 +01:00
Evgeni Golov
1258128eca explicitly recommend to inherit CSS via @import
while `@import` is mentioned in the `stylesheet` section, it is not clear that `inherit` won't add the base themes stylesheet by default
2018-12-12 10:16:54 +01:00
Matthias Geier
0095449314 DOC: Fix some minor mistakes in "LaTeX customization" 2018-12-11 14:06:59 +01: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
e527be396a Merge pull request #5607 from tk0miya/smart_texinfo_conf_py
quickstart: Simplify generated conf.py (for texinfo)
2018-12-02 01:30:51 +09:00
Takeshi KOMIYA
f7317651a1 Refactor sphinx.search 2018-11-30 18:03:20 +09:00
Takeshi KOMIYA
4761e70c37 Merge branch '1.8' 2018-11-22 22:14:32 +09:00
Jean-François B
8412bdf9d6 Merge pull request #5645 from jfbu/latex_greek_cyrillic_letters
LaTeX: support for Greek and Cyrillic
2018-11-21 23:11:15 +01:00
jfbu
1edf2a45b9 LaTeX: font choices for Greek and Cyrillic support, and (Xe|Lua)LaTeX 2018-11-21 22:21:02 +01:00
Takeshi KOMIYA
68e0210746 doc: Add deprecation info to script_files (template variable) 2018-11-21 20:15:47 +09:00
jfbu
6283324b1a Load CMU by filename, not font name, for XeLaTeX 2018-11-17 01:46:18 +01:00
jfbu
2825e338c2 LaTeX: support for Greek and Cyrillic
0. do not escape Unicode Greek letters via LaTeX math mark-up: pass them
   through un-modified to LaTeX document,

1. if "fontenc" receives extra option LGR, then pdflatex will support
   Unicode Greek letters (not in math), and with extra option T2A it
   will support (most) Unicode Cyrillic letters.

2. for pdflatex with LGR, this will use "textalpha" LaTeX package and
   "substitutefont" package to set up some automatic font substitution
   to work around the unavailability of Greek with "times"
   package (which is default font package chosen by Sphinx for
   pdflatex), same with T2A and "substitutefont" for Cyrillic.

3. for xelatex/lualatex, set up Computer Modern Unicode as default font,
   as it supports Cyrillic and Greek scripts,

4. for platex, don't do anything special as the engine already has
   its default font supporting Cyrillic and Greek (even in math mode!)

Closes: #5251
Fixes:  #5248
Fixes:  #5247
2018-11-16 21:14:51 +01:00
Stephen Finucane
1c07f0004f doc: Add "theming" to usage guide
This one is a little unusual. The current theming doc mixes user-focused
documentation with developer-focused documentation. This is confusing
and unnecessary. Resolve the issue by splitting the doc in two. The
user-focused docs are moved to the advanced section of the usage guide,
while the developer docs remain where they are, pending the addition of
a developer guide.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 15:23:33 +01:00
Stephen Finucane
356ebd5596 doc: Rework "theming" document
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:33:36 +01:00
Stephen Finucane
71e8477597 doc: Add "websupport" to usage guide
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:23:06 +01:00
Stephen Finucane
e766336a2b doc: Rework "websupport" documents
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:23:01 +01:00
Stephen Finucane
23afd29cbb doc: Add "setuptools" to usage guide
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:22:38 +01:00
Stephen Finucane
d380617c3b doc: Add "internationalization" to the usage guide
This is added to the new "advanced" subsection.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:20:46 +01:00
Stephen Finucane
b7ff889050 doc: Rework "internationalization" document
Shuffle some things around, add some additional markup, and fix header
styles.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 12:42:27 +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
aeadcdd0b6 doc: Reorder section 2018-11-11 21:57:14 +09:00
Dmitry Shachnev
2a9cad7b2e Move language-specific data into a new JS file, language_data.js
This file is included in script_files, so it will be present even for
projects using custom templates.

Fixes #5460.
2018-11-04 12:13:07 +03:00
Jon Dufresne
1b5cf5ca7f Remove reference to deprecated easy_install
easy_install is deprecated and its use is discouraged by PyPA:

https://setuptools.readthedocs.io/en/latest/easy_install.html

> Warning: Easy Install is deprecated. Do not use it. Instead use pip.

Follow upstream advice and only recommended supported tools.
2018-11-01 18:42:48 -07:00
Takeshi KOMIYA
dcc4ac55bb latex: Move \pageautorefname to sphinxmessages.sty 2018-11-01 22:47:15 +09:00
Takeshi KOMIYA
e31326d63d Merge pull request #5545 from tk0miya/refactor_loading_extensions
Refactor loading extensions
2018-10-25 23:53:56 +09:00
Takeshi KOMIYA
00254ea256 Merge pull request #5556 from drewrisinger/drewrisinger-typo-1
[Bug]: Typo in Domains.rst
2018-10-25 22:23:26 +09:00
Takeshi KOMIYA
83c50837c1 Merge pull request #5564 from nomis/rst-typo
doc: Fix typo of "restructuredtext"
2018-10-25 22:07:00 +09:00
Drew
dc35335a35 [bug]: Correct RST header
Have correct amount of "~" for RST heading.
2018-10-24 16:28:11 -04:00
Simon Arlott
7aa750a637 doc: Fix typo of "restructuredtext" 2018-10-24 19:52:42 +01:00
Simon Arlott
f5d4e4207d doc: Fix typo of "default" 2018-10-24 19:52:24 +01:00