Takeshi KOMIYA
598b85da75
Merge branch '3.x' into master
2020-10-04 22:41:44 +09:00
Takeshi KOMIYA
178c05b059
Close #7996 : manpage: Add man_make_section_directory
...
Add a new config variable; man_make_section_directory to make a
section directory on build man page. During 3.x, it defaults to
False and will be changed to True on 4.0 release.
2020-10-03 22:30:20 +09:00
Takeshi KOMIYA
8412347f5d
Merge branch '3.x'
2020-08-14 14:28:58 +09:00
Takeshi KOMIYA
a8927bcd3e
Merge branch '3.x'
2020-08-08 18:16:59 +09:00
Michal Čihař
1bf7fe424e
i18n: Add support for having single text domain
...
The gettext_compact can now be a string which is then a single domain
for all documents.
Fixes #784
2020-08-07 20:22:30 +02:00
Chris Mayo
fe4a158caf
Fix typos in the documentation
2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
af15593c0c
Close #7768 : i18n: figure_language_filename supports {docpath} token
...
To build structured i18n imaging directory, figure_language_filename
now supports `{docpath}` token that is a dirname of the current
document.
2020-08-02 16:28:54 +09:00
Takeshi KOMIYA
327c187284
Merge branch '3.x'
2020-07-24 23:49:45 +09:00
Takeshi KOMIYA
897be0ebae
Close #7784 : i18n: The alt text for image is translated by default
...
Make alt text for image translatable by default without settings of
gettext_additional_targets.
2020-07-19 12:58:28 +09:00
Jakob Lykke Andersen
18b00d8cff
Add docs and CHANGES for C changes
2020-07-14 11:48:58 +02:00
Takeshi KOMIYA
70d521ad9c
Merge branch '3.x'
2020-07-11 21:59:58 +09:00
Takeshi KOMIYA
6dfbc5108e
Close #7849 : html: Add html_codeblock_linenos_style
2020-07-11 20:59:38 +09:00
Takeshi KOMIYA
1a223209f2
Merge branch '3.x'
2020-07-05 19:56:21 +09:00
Takeshi KOMIYA
ec3754bd94
Merge branch '3.x'
2020-07-05 01:32:54 +09:00
Takeshi KOMIYA
44f4b2ad97
Merge tag 'v3.1.0'
2020-07-05 00:10:47 +09:00
Takeshi KOMIYA
0c24baaa0c
doc: Update docs (refs: #7907 )
2020-07-04 11:56:45 +09:00
Tim Metzler
5ba5cb60e3
Use double backticks for filename example
2020-07-03 19:08:53 +02:00
Tim Metzler
3982d526b2
Shorten line to less than 85 characters
2020-07-03 14:27:14 +02:00
Tim Metzler
9dcd88709c
Clarify language specific figures format
...
I recently used sphinx for multilanguage documentation and found the explanation of the language specific figure format misleading.
I replaced the underscores by periods and added a small example.
2020-07-03 14:11:53 +02:00
Takeshi KOMIYA
068b9b5738
Merge branch '3.x'
2020-06-04 00:18:30 +09:00
Takeshi KOMIYA
a7725ad8ca
Close #7247 : linkcheck: Add linkcheck_request_headers
2020-06-01 01:48:46 +09:00
Kai Welke
0ee57a6f6e
Fixed broken link to pygments lexers doc
2020-05-26 09:35:47 +02:00
Takeshi KOMIYA
3c7d35d2a2
Merge branch '3.x'
2020-05-17 19:12:56 +09:00
Takeshi KOMIYA
b1554ae25a
doc: Fix wrong version info
2020-05-10 01:12:39 +09:00
Takeshi KOMIYA
42aa293679
Merge branch '3.x'
2020-04-27 00:54:23 +09:00
Takeshi KOMIYA
05aff200b1
LaTeX: Add :confval:latex_theme_options to override theme options
2020-04-20 00:51:08 +09:00
Takeshi KOMIYA
1aca70cf80
Merge branch '3.x'
2020-04-13 23:36:49 +09:00
Takeshi KOMIYA
b2a601a33d
Merge branch '3.0.x' into 3.x
2020-04-13 23:36:10 +09:00
Jakob Lykke Andersen
d4058eb67f
C, parse attributes
2020-04-13 13:43:26 +02:00
Tetsuo Koyama
4983a12f21
➕ 🇧🇬 🇮🇳 🇦🇱 🇷🇸
2020-04-12 19:04:42 +09:00
Takeshi KOMIYA
10d7760156
Fix #7410 : Allow to suppress "circular toctree references detected" warnings
2020-04-12 15:25:35 +09:00
Takeshi KOMIYA
c7e590818a
Merge branch '3.x'
2020-03-21 17:53:22 +09:00
Jakob Lykke Andersen
f12a7f1ae2
Simplify backslash stripping
2020-03-20 13:26:45 +01:00
Jakob Lykke Andersen
e0f779ba3d
Remove backslash stripping in domains.
...
Adds several ways to reinstate the old behaviour.
Fixes sphinx-doc/sphinx#6462
2020-03-20 12:25:31 +01:00
Takeshi KOMIYA
3e0618ba3a
Deprecate codes for docutils-0.13 or 0.14
2020-03-07 19:36:41 +09:00
Takeshi KOMIYA
cdbefb600f
Support user defined LaTeX themes
2020-03-06 22:11:25 +09:00
Takeshi KOMIYA
a033d53c24
Close #7032 : html_scaled_image_link is disabled for individual image
2020-02-18 01:48:11 +09:00
Takeshi KOMIYA
0c0d037059
Merge pull request #7083 from tk0miya/update_docs
...
doc: Make desc of gettext_additional_targets easy to read
2020-02-01 13:39:21 +09:00
Takeshi KOMIYA
423a7a7131
doc: Make desc of gettext_additional_targets easy to read
2020-02-01 13:12:32 +09:00
Takeshi KOMIYA
15c266c445
Merge branch '2.0'
2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
9bd64e4e2a
Merge pull request #6862 from tk0miya/6854_update_supported_languages_list
...
Update supported languages (refs: #6854 )
2019-11-27 00:04:22 +09:00
Takeshi KOMIYA
995dfa4e73
Merge pull request #6816 from jonashaag/linkcheck-auth
...
Add linkcheck_auth option
2019-11-26 01:29:30 +09:00
Takeshi KOMIYA
1faf14d411
Update supported languages (refs: #6854 )
2019-11-26 01:22:14 +09:00
Takeshi KOMIYA
6de29cdb84
Merge pull request #6854 from jfbu/doc_mention_Greek_as_supported_language
...
DOC: add Greek to list of supported languages
2019-11-26 00:56:34 +09:00
Jonas Haag
df2f80c755
Add linkcheck_auth option
2019-11-25 09:53:45 +01:00
jfbu
70f087990b
DOC: add Greek to list of supported languages
2019-11-22 19:15:59 +01:00
Sylvestre Ledru
3aef93c4a3
Fix the URL to https://pygments.org/docs/lexers.html
2019-11-20 14:49:15 +01:00
Takeshi KOMIYA
c6f0eb215a
Fix #4186 : LaTeX: Support upLaTeX as a new latex_engine (experimental)
2019-11-17 17:37:48 +09:00
Takeshi KOMIYA
6644830941
Merge branch '2.0'
2019-11-17 14:24:04 +09:00
Takeshi KOMIYA
32763520a3
Close #1331 : Change default User-Agent header
2019-10-27 02:05:33 +09:00
Takeshi KOMIYA
a6a2a59ab0
Merge branch '2.0'
2019-10-20 13:43:30 +09:00
jfbu
7be68b7c4b
Add latexpdf support for Greek as main language (via xelatex use)
...
Closes : #6710
2019-10-01 10:27:43 +02:00
ExplorerLog
edff2824e9
Update configuration.rst
...
Add a comma
2019-08-16 16:29:29 +08:00
Takeshi KOMIYA
91fceb4b5f
Merge branch '2.0.2' into 2.0
2019-06-02 00:58:46 +09:00
Gibson Fahnestock
6f7cb4da94
autosectionlabel: add type for suppress_warnings
...
This sets the subtype to the filename, which means that you can suppress
warnings for individual paths.
For example for the following warning:
```
path/to/file.rst:5547: WARNING: duplicate label path/to/file:label, other instance in /path/to/file.rst
```
You would add this to `config.py` to suppress all warnings:
```python
extensions = [
'sphinx.ext.autosectionlabel',
]
autosectionlabel_prefix_document = True
suppress_warnings = [
'autosectionlabel.*',
]
```
To suppress warnings for the individual file path you would do:
```python
suppress_warnings = [
'autosectionlabel.path/to/file',
]
```
Fixes: https://github.com/sphinx-doc/sphinx/issues/6371
2019-05-15 19:30:46 +01:00
jfbu
9ecd42574d
Documentation of smartquotes_excludes (and smartquotes_action)
2019-04-12 18:34:10 +02:00
Takeshi KOMIYA
9548b06d02
docs: Add a tip about $REQUESTS_CA_BUNDLE
2019-02-24 20:03:21 +09:00
Takeshi KOMIYA
1ece29597e
Merge branch 'master' into simplify_conf.py
2019-02-16 21:25:21 +09:00
Takeshi KOMIYA
a3cdd465ec
HTML builder outputs HTML5 by default
2019-02-11 17:46:56 +09:00
Takeshi KOMIYA
319adefa9f
epub: `epub_title defaults to the project` option
2019-02-09 15:00:27 +09:00
Jean-François B
a8feb0bec8
Merge pull request #5919 from jfbu/latex_docs
...
[DOC] Move description of latex_elements to latex.rst
2019-01-12 11:05:50 +01:00
Takeshi KOMIYA
b535e13235
Fix doc: html_baseurl was added in 1.8.0
2019-01-12 13:16:31 +09:00
jfbu
ad8205bb0b
[DOC] Move description of latex_elements to latex.rst
2019-01-10 16:48:03 +01:00
Jon Dufresne
f1e41a616c
Remove outdated fallback to 'import Image'
...
The fallback 'import Image' was added in commit
99621d7a01https://github.com/python-pillow/Pillow
Old PIL website: http://www.pythonware.com/products/pil/
2019-01-07 06:44:35 -08: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
jfbu
701b39328f
Merge branch '1.8'
...
(Resolved) Conflicts:
sphinx/texinputs/sphinxmanual.cls
2018-12-23 11:23:04 +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
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
Takeshi KOMIYA
aeadcdd0b6
doc: Reorder section
2018-11-11 21:57:14 +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
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
973c3ffa25
Merge branch 'master' into change_master_doc_to_index
2018-09-29 21:12:40 +09: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
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
Timotheus Kampik
26bd565dee
Merge branch 'master' into 1618-make-search-results-reader-friendly
2018-08-27 21:34:43 +02:00
Takeshi KOMIYA
f670a33f5b
Fix #5246 : Add :confval:singlehtml_sidebars to configure sidebars for singlehtml
2018-08-13 11:04:45 +09:00
Takeshi KOMIYA
68630e68b9
Merge branch '1.7'
2018-08-04 20:34:42 +09:00
Jean-François B
5edcb2850c
Merge pull request #5239 from jfbu/latex_revert_5181_RTDbug_workaround
...
Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD"
2018-07-31 19:04:21 +02:00
jfbu
d07103fde2
Fix typo in updated docs
2018-07-31 17:11:59 +02:00
jfbu
b8f43e56ae
Update latex docs
2018-07-31 16:54:25 +02:00
jfbu
f0067f4a04
Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD"
...
This reverts commit 9b2aac68ea
2018-07-31 10:46:48 +02:00
jfbu
9a0097bef2
Update LaTeX xindy docs
2018-07-30 19:52:12 +02:00
Takeshi KOMIYA
e045dacc84
doc: Move description for math confval, directives and roles to usage
2018-07-28 18:43:02 +09:00
Takeshi KOMIYA
a3189b460c
Merge pull request #5136 from TimKam/4255-clarify-startdocname-config-param
...
#4255 clarify documentation of ``startdocname`` parameters.
2018-07-21 16:31:48 +09:00
Timotheus Kampik
395d60d49e
#4255 improve conciseness
2018-07-19 21:10:16 +02:00
Takeshi KOMIYA
a7ea9d7c5b
Merge pull request #5185 from TimKam/4886-linkcheck-ignore-doc
...
4886 correct link check ignore doc
2018-07-19 23:52:29 +09:00
Timotheus Kampik
8066d36e3c
#4886 clarify example/note
2018-07-18 19:40:22 +02:00
Timotheus Kampik
f605012617
#4886 remove obsolete *
2018-07-17 20:40:49 +02:00
Timotheus Kampik
6bbfc3bba9
#1618 remove obsolete warning from doc
...
Setting `html_copy_source` no longer affects search results
2018-07-17 19:59:29 +02:00
Timotheus Kampik
537a69e518
#4886 adjust documentation to match actual link check behavior
2018-07-16 23:22:26 +02:00
Jean-François B
54456ba455
Merge branch 'master' into 3742_index_in_PDF_bookmark_at_RTD
2018-07-16 17:15:45 +02:00
jfbu
9b2aac68ea
LaTeX: extend to all projects the #3742 fix for PDF builds at RTD
...
Refs: https://github.com/rtfd/readthedocs.org/issues/2857
2018-07-15 15:24:25 +02:00
jfbu
60b160431a
LaTeX: add hyperref support to general index as handled by xindy
...
- achieve hyperlinked page numbers in general index, despite xindy's
incompatibility with hyperref,
- obtain compatibility of pdflatex with xindy for documents with
Cyrillic scripts,
- use xindy by default with xelatex/lualatex because any non-ascii
character as first letter of an indexed term breaks PDF build if using
makeindex with lualatex, and produces incoherent index with xelatex.
This commit also switches off xindy logs (which were activated in parent
commits) as they are voluminous and not of immediate use to Sphinx user.
2018-07-14 19:13:59 +02:00
Timotheus Kampik
94b467dbc8
#4255 clarify documentation of `startdocname` parameters.
...
* Relative path from source directory
* Similar to ``master_doc`` in functionality
2018-07-01 16:10:51 +02:00
jfbu
90c2b528b1
Update docs and CHANGES for `latex_use_xindy` config variable
2018-06-30 23:37:26 +02:00
Takeshi KOMIYA
1140e81df7
Merge remote-tracking branch 'stephenfin/doc-rework'
2018-06-26 01:05:19 +09:00
Daniel Hahler
8f94429a21
doc: fix func/meth references to Sphinx
2018-06-25 08:25:56 +02:00
Stephen Finucane
d9ccc95717
doc: Add "extensions" to usage guide
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:30:47 +01:00
Takeshi KOMIYA
fc7817b854
Merge pull request #5034 from tk0miya/add_html_js_files
...
Add :confval:`html_js_files`
2018-06-09 11:51:11 +09:00
Jean-François B
95a8099913
Merge branch 'master' into latex_remove_shorthandoff_variable
2018-06-08 19:53:46 +02:00
Takeshi KOMIYA
9fc2657d7e
Add :confval:html_js_files
2018-06-09 02:38:36 +09:00
jfbu
359854fa78
Postpone to 3.0 removal of ExtBabel.get_shorthandoff()
2018-06-07 18:29:24 +02:00
jfbu
b41b1dac5c
Deprecate sphinx.writers.latex.ExtBabel.get_shorthandoff()
...
This partially reverts d17f3955a5
2018-06-06 19:16:14 +02:00
Takeshi KOMIYA
e30b10a57d
html: Output `canonical_url metadata if :confval:html_baseurl` set
2018-06-06 21:18:17 +09:00
jfbu
a32c358342
Remove usage of internal shorthandoff variable from LaTeX writer
2018-06-05 18:38:59 +02:00
Daniel M. Capella
d2b0098045
doc: Fix minor typo "like" -> "link"
2018-05-13 04:15:11 +00:00
Takeshi KOMIYA
5a90e0bc85
Update docs (refs: #4875 )
2018-05-03 17:40:32 +09:00
Takeshi KOMIYA
cbf4ee24f9
Fix #4811 : The files under html_static_path are excluded from source
2018-05-03 11:07:14 +09:00
Stephen Finucane
0bf8886fc4
doc: Address review comments
...
These came up in the review for pull request #4799 .
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-04-30 21:41:12 +01:00
Stephen Finucane
16e76faba3
doc: Add "config" to usage guide
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-04-30 21:36:45 +01:00
