Commit Graph

2227 Commits

Author SHA1 Message Date
Arthur
adc1d2b59d Merge branch 'master' into docs/extension-tutorials 2018-11-30 10:33:20 +01: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
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
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
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
44b385e2c9 Merge pull request #5533 from ericvw/autodoc_member-only_default-options
autodoc: Respect `member-order` in `autodoc_default_options` as documented
2018-10-17 11:12:56 +09: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
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
Drew
3812d06544 Update domains.rst 2018-10-10 15:56:29 -04: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
6c83b8b9f4 Merge pull request #5484 from jdufresne/intro
Correct intro.rst with regards to required Python version
2018-09-29 21:36:27 +09:00
Takeshi KOMIYA
973c3ffa25 Merge branch 'master' into change_master_doc_to_index 2018-09-29 21:12:40 +09:00
Jon Dufresne
2d0b5969a0 Correct intro.rst with regards to prerequisites 2018-09-24 17:17:54 -07:00
Takeshi KOMIYA
ff8df59ac1 Merge pull request #5479 from jdufresne/https
Prefer https:// links where available
2018-09-24 09:04:54 +09:00
Takeshi KOMIYA
895d41e659 Merge pull request #5477 from jdufresne/version
Correct installation docs about supported Python versions
2018-09-24 08:59:54 +09:00
Takeshi KOMIYA
6843dd0e15 Merge pull request #5368 from tk0miya/deprecate_doc2path_suffix
Deprecate arguments of env.doc2path()
2018-09-24 08:55:28 +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
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
dc44b0d2a9 Merge branch 'master' into HEAD 2018-09-22 22:54:15 +09:00
Takeshi KOMIYA
3a2418a827 refactoring: Drop PY2 and PY3 flags 2018-09-22 21:27:59 +09:00