summaryrefslogtreecommitdiff
path: root/doc/conf.py
Commit message (Collapse)AuthorAgeFilesLines
...
* Outdated comment in docs config for intersphinxFrançois Freitag2020-10-051-2/+0
| | | | Intersphinx is in use since 6a396c7eb85e4f2e2291652c454352bad1a397f4.
* doc: Fix html_use_opensearch of sphinx-doc.orgTakeshi KOMIYA2020-04-191-1/+1
|
* DOC: Use html_baseurlMatthias Geier2020-04-171-0/+1
|
* Enable intersphinx with Sphinx's documentationDaniel Hahler2020-03-091-0/+1
|
* Merge branch '2.0'Takeshi KOMIYA2020-02-161-1/+1
|\
| * Update copyright for 2020Simon Willison2020-02-131-1/+1
| |
* | doc: Fix ambiguous confval entries and referencesTakeshi KOMIYA2019-12-291-0/+3
|/
* Merge pull request #6164 from goerz/inheritance_diagramTakeshi KOMIYA2019-03-191-1/+1
|\ | | | | Fix docs of inheritance-diagram "parts" option
| * Fix docs of inheritance-diagram "parts" optionMichael Goerz2019-03-101-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The documentation now correctly describes the behavior of the ``parts`` option in an inheritance-diagram directive: it gives the number of parts that are *kept* not dropped. The option now also accepts negative values, which drops parts from the left (which is the what the documentation incorrectly claimed the option would do for positive values) As a form of testing of the new functionality, the documentation for the inheritance_diagram extension now includes a section "Examples" that demonstrate the different possibilities. This would fail to build without the patch. Closes #4872
* | Python-3-only clean ups discovered by pyupgradeJon Dufresne2019-03-171-1/+1
|/ | | | | | | | | | | | | | https://github.com/asottile/pyupgrade > A tool to automatically upgrade syntax for newer versions of the > language. - Drop u str prefix - Drop base object inheritance - Drop args to super() - Use set literals - Use dict comprehension - Use set comprehension
* Merge branch '1.8'Takeshi KOMIYA2019-01-021-1/+1
|\
| * A happy new year!Takeshi KOMIYA2019-01-021-1/+1
| |
* | Remove unnecessary encoding cookie from Python source filesJon Dufresne2018-12-161-2/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* | Merge branch '1.8'Takeshi KOMIYA2018-11-221-0/+1
|\ \ | |/
| * Move language-specific data into a new JS file, language_data.jsDmitry Shachnev2018-11-041-0/+1
| | | | | | | | | | | | | | This file is included in script_files, so it will be present even for projects using custom templates. Fixes #5460.
* | LaTeX: font choices for Greek and Cyrillic support, and (Xe|Lua)LaTeXjfbu2018-11-211-6/+6
| |
* | LaTeX: support for Greek and Cyrillicjfbu2018-11-161-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | doc: app.info() should allow keyword argumentTakeshi KOMIYA2018-09-201-3/+3
| |
* | doc: Update workaround for RTDTakeshi KOMIYA2018-09-201-1/+3
| |
* | Fix typoTakeshi KOMIYA2018-09-201-1/+1
| |
* | Add workaround for RTD (refs: #5461)Takeshi KOMIYA2018-09-201-0/+5
|/
* Revert "LaTeX: extend to all projects the #3742 fix for PDF builds at RTD"jfbu2018-07-311-1/+6
| | | | This reverts commit 9b2aac68ead15067205470ec28c94af909c080c0.
* Merge branch 'master' into 3742_index_in_PDF_bookmark_at_RTDJean-François B2018-07-161-0/+1
|\
| * Use xindy for Sphinx's own PDF documentationjfbu2018-07-141-0/+1
| | | | | | | | | | Makeindex gathered under heading "Symbols" all command line options, this seems less satisfactory than index produced by xindy.
* | LaTeX: extend to all projects the #3742 fix for PDF builds at RTDjfbu2018-07-151-6/+1
|/ | | | Refs: https://github.com/rtfd/readthedocs.org/issues/2857
* Update Python 2 doc links to Python 3Jon Dufresne2018-06-091-1/+1
| | | | Python 3 docs are more actively maintained and are the future.
* doc: Fix filenameTakeshi KOMIYA2018-04-121-1/+1
|
* Merge branch '1.7'jfbu2018-03-301-1/+6
|\
| * Better font config for Sphinx own PDF docsjfbu2018-03-301-1/+6
| |
* | Fix Unicode Character U+229E (SQUARED PLUS) breaks Sphinx docs in LaTeXjfbu2018-03-301-0/+1
|/ | | | refs: PR #4794
* Use flake8-import-orderTakeshi KOMIYA2018-01-281-0/+1
|
* Merge branch 'happy_new_year' into masterTakeshi KOMIYA2018-01-011-1/+1
|\
| * A happy new year!Takeshi KOMIYA2018-01-011-1/+1
| |
* | doc: Add sphinx-autogen man pageStephen Finucane2017-07-111-0/+2
|/ | | | | | This wasn't documented in depth anywhere, so do just that. Signed-off-by: Stephen Finucane <stephen@that.guru>
* fix #3840: epub_uid should be XML NameYoshiki Shibukawa2017-06-301-0/+1
|
* Fix flake8jfbu2017-05-201-1/+1
|
* Fix #3742: missing ``Index`` bookmark and TOC entry in PDF builds at RTDjfbu2017-05-201-1/+6
| | | | | | | | | | | The trick is to create an Index TOC/bookmarks entry in anticipation of makeindex execution, as RTD (currently) does only one pdflatex run after makeindex. https://github.com/rtfd/readthedocs.org/issues/2857 The workaround works for Sphinx own docs, which uses ``'manual'`` docclass and puts the general index at very end of document.
* Fix the unreleased version number is shown (refs: #3678, #3027)Takeshi KOMIYA2017-04-281-1/+1
|
* Year++Takeshi KOMIYA2017-03-261-1/+1
|
* Fix accidental use of ``language='ja'`` in docs (at 41bb388)jfbu2017-03-231-1/+1
|
* Update docs (domains.rst)jfbu2017-03-211-1/+1
|
* improve the index appearance in Sphinx's own PDF documentationjfbu2017-02-051-0/+1
|
* style the latex chapter in the docs (for pdf output)jfbu2016-10-291-0/+1
|
* Fix #2983: Rename ``epub3_description`` and ``epub3_contributor`` to ↵Takeshi KOMIYA2016-10-011-1/+1
| | | | ``epub_description`` and ``epub_contributor``.
* fix epub warning in Sphinx's documentYoshiki Shibukawa2016-08-091-3/+4
|
* Reduce epub checker warnings/errors for epub3 builder.Yoshiki Shibukawa2016-07-171-1/+1
| | | | | | | | | Fix DOCTYPE to html5 and change extension from .html to .xhtml. Sphinx's documents result: before: 95 warnings& 1238 errors after: 623 errors
* Obligatory copyright update.Georg Brandl2016-01-141-1/+1
|
* final pep8 fixes; reactivate most warnings in flake8Georg Brandl2015-03-081-5/+6
|
* Closes #1735: Use https://doc.python.org/ instead of ``http`` protocol. It ↵shimizukawa2015-02-231-1/+1
| | | | was used for `sphinx.ext.intersphinx` and some documentation.
* Merge branch 'stable'Georg Brandl2015-01-031-1/+1
|\