summaryrefslogtreecommitdiff
path: root/doc/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #10648 from jfbu/latex_enhancedboxesJean-François B2022-07-141-1/+2
|\ | | | | LaTeX: box padding (t,r,b,l), borders (t,r,b,l), shadows (x,y) or radii
| * LaTeX: enhanced boxes with padding, borders, shadows, rounded cornersJean-François B2022-07-141-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - LaTeX: box padding (t,r,b,l), borders (t,r,b,l), shadows (x,y) or radii - LaTeX: fix #10650 via usage of our own sophisticated \fcolorbox - LaTeX: user interface via 'sphinxsetup' to enhanced code-blocks frames - LaTeX: user interface via 'sphinxsetup' to enhanced topic boxes - LaTeX: CSS-named-alikes 'sphinxsetup' options for code-blocks and topics - LaTeX: CSS-named-alikes 'sphinxsetup' keys for warning type notices (fix #10651) - LaTeX: documentation of the new CSS-like options - LaTeX: remove #10619 documentation, as the #10619 added shadowBorderColor and shadowShadowColor now named respectively: aside.topic_border-TeXcolor and aside.topic_box-shadow-TeXcolor - LaTeX: use div.topic option prefix and not aside.topic for CSS-like options - LaTeX: keep the implicit legacy padding of warning type boxes as default behaviour
* | Refresh the Sphinx13 theme (#10652)Adam Turner2022-07-101-11/+13
|/
* LaTeX: optional rounded corners for framing of code-blocksJean-François B2022-07-051-0/+5
| | | | | | | | | | Via a new configuration verbatimradius of 'sphinxsetup', which defaults to 0pt. If this dimension is non zero, the LaTeX package pict2e will be loaded to help construct frames with rounded corners for code-blocks. And if the LaTeX package pict2e was not found, a LaTeX warning is issued during PDF build.
* Merge branch '4.x' into 5.0.xTakeshi KOMIYA2022-05-281-1/+1
|\
| * Update URL for requestsTakeshi KOMIYA2022-05-281-1/+1
| |
* | Don't use deprecated `setup.py build_sphinx`Adam Turner2022-04-161-2/+2
| |
* | Merge branch '4.x'Takeshi KOMIYA2022-03-271-1/+1
|\ \ | |/
| * doc: URL of requests has changed nowTakeshi KOMIYA2022-03-271-1/+1
| |
* | doc: Linkify issue numbers in changelog to GitHubMartin Fischer2022-01-081-0/+24
| |
* | Merge branch '4.x'Takeshi KOMIYA2022-01-011-1/+1
|\ \ | |/
| * A happy new year!Takeshi KOMIYA2022-01-011-1/+1
| |
* | Merge branch '4.x'Takeshi KOMIYA2021-12-101-0/+1
|\ \ | |/
| * Describe deployment on Read the Docs and GitHub PagesJuan Luis Cano Rodríguez2021-11-181-0/+1
| |
* | Merge branch '4.x'Takeshi KOMIYA2021-09-121-1/+1
|\ \ | |/
| * Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|gJon Dufresne2021-09-061-1/+1
| | | | | | | | | | | | https://sphinx-doc.org is unreachable, but is linked from the PyPI page: https://pypi.org/project/Sphinx/. Switch to https://www.sphinx-doc.org/ instead.
* | Merge branch '4.x'Takeshi KOMIYA2021-05-191-4/+4
|\ \ | |/
| * doc: Upgraded some of sphinx-doc.org links to HTTPSigo958622021-05-161-1/+1
| | | | | | | | | | Seems like that link is used in some tests and code so upgrading it outside documentation might break something
| * doc: Upgrade docutils.sourceforge.io links to HTTPSigo958622021-05-161-3/+3
| | | | | | | | | | Also change any docutils.sourceforge.net link to io top level domain.
* | extlinks: Emit a warning if extlnks config does not contain '%s'Takeshi KOMIYA2021-05-031-3/+3
|/ | | | | | To let users know the deprecation surely, use logger.warning instead of RemovedInSphinxXXWarning since 5.0. It will cause a crash if users use `-W` option on their CI.
* Merge branch 'master' into pdf_bookmarksdepthJean-François B2021-03-121-1/+2
|\
| * Close #7549: autosummary: Enable autosummary_generate by defaultTakeshi KOMIYA2021-03-101-0/+1
| |
| * Close #8326: Rename master_doc to root_docTakeshi KOMIYA2021-02-281-1/+1
| | | | | | | | | | | | To describe the purpose more accurately, the `master_doc` is now renamed to `root_doc`. The old name is still available. But it is recommeneded to use new one from now on.
* | LaTeX: let bookmarks use high default depthjfbu2021-02-181-2/+1
|/ | | | Add bookmarksdepth key to latex_elements['sphinxsetup']
* Merge branch '3.x'Takeshi KOMIYA2021-02-091-0/+1
|\
| * Fix #8837: doc: Remove version info from html_titleTakeshi KOMIYA2021-02-071-0/+1
| |
* | Revert alteration at c9480f994 merge of 3.x of doc/conf.pyjfbu2021-01-271-12/+0
|/ | | | | | | Compare doc/conf.py after merge at c9480f994 to what it was at 2ee033838. It loses the modification from #8716 (merged at 38c614347) and thus reverts doc/conf.py to former font config using mathpazo.
* Improve Sphinx own pdf docsjfbu2021-01-241-2/+9
| | | | | | | | | | | | | Prior to this the depth of the bookmarks is too low, one does not even get to see for example what are the built-in extensions offered by Sphinx. Similarly the LaTeX created table of contents has not enough depth. Dozens of contiguous pages from our documentation get only a single link, it is very hard for newcomer to get some feeling of the scope of Sphinx. With a more detailed table of contents (be it inside the PDF or via the collapsable bookmark panel of PDF viewer) learning Sphinx is easier.
* A happy new year!Takeshi KOMIYA2021-01-011-1/+1
| | | | | | | .. note:: $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \; $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
* Fix #6629: linkcheck: Handle rate-limitingFrançois Freitag2020-11-251-1/+4
| | | | | Follow the Retry-After header if present, otherwise use an exponential back-off.
* Sort imports with isortFrançois Freitag2020-11-111-1/+0
| | | | | | | | | | | | Keep imports alphabetically sorted and their order homogeneous across Python source files. The isort project has more feature and is more active than the flake8-import-order plugin. Most issues caught were simply import ordering from the same module. Where imports were purposefully placed out of order, tag with isort:skip.
* DOC: Add faviconMatthias Geier2020-10-241-0/+1
|
* 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
| |
View Lorry Controller Status