Commit Graph

139 Commits

Author SHA1 Message Date
Jon Dufresne
f1e41a616c Remove outdated fallback to 'import Image'
The fallback 'import Image' was added in commit
99621d7a01 for the PIL package. However,
the PIL package is no longer maintained and does not support Python 3.
Development has moved to the Pillow package which always installs to the
PIL namespace.

Pillow repo: https://github.com/python-pillow/Pillow
Old PIL website: http://www.pythonware.com/products/pil/
2019-01-07 06:44:35 -08:00
jfbu
58f4c658fa Capitalize the Internet 2018-12-29 18:54:06 +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
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
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
1920d1d950 LaTeX: `\sphinxmaketitle and optional \sphinxbackoftitlepage`
Closes: #5849
2018-12-21 21:38:27 +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
a1976cc0c8 Update docs 2018-12-19 01:32:26 +09: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
jfbu
7364e0c2fd Update docs for LuaLaTeX 2018-12-15 15:16:43 +01: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
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
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
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
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
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
Takeshi KOMIYA
aeadcdd0b6 doc: Reorder section 2018-11-11 21:57:14 +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
Eric N. Vander Weele
9fcef5030a autodoc: Respect member-order in autodoc_default_options as documented
In the `autodoc_default_options` documentation, it mentions that
`member-order` is respected; however, when setting the key-value pair in
`conf.py`, it is not.  Thus, add `member-order` as one of the default
options respected in `conf.py`.  Additionally, update the list of
supported options to match the example.
2018-10-16 10:21:18 -07:00
Drew
3812d06544 Update domains.rst 2018-10-10 15:56:29 -04:00
Takeshi KOMIYA
973c3ffa25 Merge branch 'master' into change_master_doc_to_index 2018-09-29 21:12:40 +09:00
Takeshi KOMIYA
ff8df59ac1 Merge pull request #5479 from jdufresne/https
Prefer https:// links where available
2018-09-24 09:04:54 +09:00
Jon Dufresne
dd383ec472 Prefer https:// links where available 2018-09-23 11:50:42 -07:00
Jon Dufresne
d9283a40d8 Correct installation docs about supported Python versions
Since commit 9412bd76b7, older Python
versions have been dropped.
2018-09-23 08:44:29 -07:00
Rob Ruana
e547a6a0d2 Fixes #5426: [Napoleon] Better handling of inline attributes (#5470)
* Fixes #5426: [Napoleon] Better handling of inline attributes

* Removes uneeded NOQA comments

* Fixes imports
2018-09-23 09:26:17 -04:00
Jon Dufresne
490e4aed41 Remove unnecessary object from class definitions
In Python 3, all classes are new-style classes. The object in the
definition is redundant and unnecessary.
2018-09-11 07:07:01 -07:00
Takeshi KOMIYA
07fd1c0680 Fix #4018: htmlhelp: Add htmlhelp_file_suffix and htmlhelp_link_suffix 2018-09-08 23:11:14 +09:00
Takeshi KOMIYA
342de4f0fd Merge branch '1.8' 2018-09-05 23:10:20 +09:00
Takeshi KOMIYA
79de756423 Merge pull request #5342 from tk0miya/drop_py2_support
Update requirements and dependencies for Sphinx-2.0
2018-09-05 22:55:07 +09:00
Takeshi KOMIYA
abcb5bd5ec The default setting for master_doc is changed to 'index' 2018-09-04 01:14:16 +09:00
TAKEDA-Takashi
683cccac4d docs: Fix wrong name of MecabSplitter 2018-09-03 16:18:24 +09:00
Takeshi KOMIYA
daac35cda7 doc: Add versionadded label (refs: #5029) 2018-09-03 10:46:38 +09:00