summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Allow ``copyright`` to contain multiple entries (#10983)Stefanie Molin2023-05-112-1/+5
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Allow multi-line object description signatures (#11011)TLouf2023-05-113-0/+151
| | | | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-authored-by: Jean-François B <2589111+jfbu@users.noreply.github.com> Co-authored-by: TLouf <loufthomas@gmail.com>
* Warn on deprecated Python-specific index types (#11412)Adam Turner2023-05-092-16/+60
|
* Remove deprecated ``style`` key for HTML templates (#11381)Adam Turner2023-04-281-16/+0
|
* Remove the deprecated Setuptools integration (#11363)Adam Turner2023-04-275-206/+1
|
* Remove unneeded JavaScript from ``sphinx13`` themeAdam Turner2023-04-231-134/+0
|
* Note correct deprecation version for ``sphinx.util.osutil.cd``Adam Turner2023-04-231-1/+1
|
* Revert "Support and prefer ``.jinja`` to ``_t`` for static templates ↵James Addison2023-04-232-46/+8
| | | | | (#11165)" (#11329) This reverts commit 5d13215b58f93c6be8255ef2e3e20836508c7d47.
* Create a 'search field' component for themes (#11045)Tim Hoffmann2023-04-212-1/+6
| | | | | | | | | | | | | ``searchfield.html`` is similar to the existing ``searchbox.html``, but does not have the heading "Quick Search". Instead, it uses "Search" as a placeholder text. This gives a cleaner and less cluttered appearance. The searchfield component is added to the basic theme and thus can be used in any derivative theme. It is not used by default for backward compatibility. The searchfield compenent is made the default in the sphinx13 theme. CSS changes ensure that the top of the search field is aligned with the top of the main content.
* Add link to Weblate's Sphinx docs in intl documentation (#11332)Maciej Olko2023-04-161-0/+7
| | | Add link to Weblate in intl documentation
* Use longtable for our document in PDF formatJean-François B2023-04-111-0/+1
| | | | | Previous commit applied longtable class to the next one, but this still left the previous table prevent an earlier page break.
* Use a :class:`longtable` in our document for LaTeX PDF outputJean-François B2023-04-111-0/+1
| | | | Now that #11268 has been fixed via #11319.
* Add a missing word in ``doc/development/theming.rst`` (#11301)James Addison2023-04-071-1/+1
|
* Support and prefer ``.jinja`` to ``_t`` for static templates (#11165)James Addison2023-04-072-8/+46
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-0622-54/+122
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* Add an option for displaying short ``Literal`` types (#11109)Adam Turner2023-04-051-0/+30
| | | | | | The new ``python_display_short_literal_types`` configuration option for the ``py`` domain controls display of PEP 586 ``Literal`` types. The 'short' format is inspired by PEP 604, using the bitwise OR operator to distinguish the possible legal values for the argument.
* Update doc and CHANGES for PR #11281Jean-François B2023-04-031-0/+25
|
* LaTeX: rename ``\sphinxnotetitle`` into ``\sphinxstylenotetitle`` (etc)Jean-François B2023-03-271-49/+48
| | | | | Follow-up to #11266. Using \sphinxstyle prefix looked a posteriori better, for coherency, although it is a bit long.
* LaTeX: let \sphinxremovefinalcolon work also if no colon in inputJean-François B2023-03-271-0/+10
|
* Fix typos found by codespellDimitri Papadopoulos2023-03-272-2/+2
|
* LaTeX: add \sphinxnotetitle et al.Jean-François B2023-03-261-0/+21
| | | | | | | | In passing I reverted some deprecation I had added at 6bf40599e to some internals of the sphinxadmonition environment, as it does not look that pressing anyhow and the redundant namings of two colors in particular may nevertheless prove useful to user \renewcommand's, as they avoid to have to refer to \spx@noticetype.
* LaTeX: let mark-up for seealso directive use explicit colon (fix #11264)Jean-François B2023-03-261-4/+6
|
* Fix syntax in ``:manpage:`` role example (#11249)Hugo van Kemenade2023-03-241-1/+1
|
* Normalise spelling of Sphinx versionsAdam Turner2023-03-242-5/+4
|
* Remove obsolete workarounds in ``doc/conf.py`` (#11250)Dmitry Shachnev2023-03-231-16/+0
| | | | | | | Loading jQuery is not needed since January 2023: https://github.com/readthedocs/readthedocs.org/pull/9861 And exposing app.{info,warn,debug} is not needed since September 2018: https://github.com/readthedocs/readthedocs-sphinx-ext/pull/51
* Docs: Add a link to sphinx-extensions (#11260)Benjamin Balder Bach2023-03-231-2/+4
|
* LaTeX: doc updatesJean-François B2023-03-201-8/+9
| | | | modified: doc/latex.rst
* LaTeX: update doc, trim unneeded extra examplesJean-François B2023-03-201-66/+30
|
* LaTeX: support elliptical corners in rounded boxesJean-François B2023-03-191-36/+50
|
* LaTeX: remove more-or-less obsolete docJean-François B2023-03-191-13/+0
|
* LaTeX: fix nits with some mark-up in doc and code commentJean-François B2023-03-191-2/+2
|
* LaTeX: warn about \sphinxbox addstrut default possibly changed at 7.0.0Jean-François B2023-03-191-4/+10
|
* LaTeX: add <prefix>_{TeXcolor,TeXextras} optionsJean-François B2023-03-191-41/+104
| | | | | | | | And add <type>TextColor and <type>TeXextras for <type>=hint, important, note, tip for variants which do not trigger for sphinxheavybox but still uses sphinxlightbox (suitably enhanced). Similar named TeXcolor and TeXextras options for \sphinxbox.
* LaTeX: reset options in nested \sphinxbox'esJean-François B2023-03-191-4/+10
|
* Deprecate legacy ``intersphinx_mapping`` format (#11247)Adam Turner2023-03-171-11/+23
| | | This format was made obsolete in Sphinx 1.0, but never formally deprecated.
* Display examples of roles in the documentation (#11226)Hugo van Kemenade2023-03-171-9/+38
| | | | Show examples of roles in the docs so we can see how they look. Seeing how roles are displayed helps us decide whether to use them.
* LaTeX: let rounded boxes support up to 4 distinct border-widthsJean-François B2023-03-151-17/+33
| | | | | | | Internally replace "strokepath" operation for drawing the border (which mandated constant border-width) by only "fillpath" operations. This also allowed to significantly simplify some other aspects of the code related to box-decoration-break=slice.
* LaTeX: add boolean option addstrut to \sphinxbox/\sphinxboxsetupJean-François B2023-03-141-3/+12
|
* LaTeX: also admonition directives support box-decoration-break=sliceJean-François B2023-03-131-4/+11
|
* LaTeX: encapsulate dimension options in \dimexprJean-François B2023-03-131-15/+24
|
* LaTeX: polish code commentsJean-François B2023-03-131-5/+5
|
* LaTeX: mumble with trailing whitespaces in latex.rstJean-François B2023-03-121-2/+2
|
* LaTeX: documentation and a mark-up fix in latex.rstJean-François B2023-03-121-34/+41
|
* Fix #11235: LaTeX: ``\color`` may cause color leaks in topic or noticesJean-François B2023-03-121-2/+1
|
* LaTeX: add support for styling ``note`` (``hint``, ...) similarly as ↵Jean-François B2023-03-121-244/+289
| | | | ``warning`` ( ``danger``, ...) (#11234)
* LaTeX: fix some documentation from #11224Jean-François B2023-03-071-9/+24
|
* Update some LaTeX comments and documentation after #11224Jean-François B2023-03-071-1/+0
|
* LaTeX: ``\sphinxbox`` for boxing inline text elementsJean-François B2023-03-071-3/+62
|
* Prefer ``contextlib.chdir`` to ``sphinx.util.osutil.cd``Adam Turner2023-03-051-0/+5
|
* Make ``--jobs`` a synonym for ``-j`` (#11210)Hugo van Kemenade2023-03-051-1/+4
| | | Make --jobs a synonym for -j