summaryrefslogtreecommitdiff
path: root/doc/usage
Commit message (Collapse)AuthorAgeFilesLines
* Allow ``copyright`` to contain multiple entries (#10983)Stefanie Molin2023-05-111-0/+4
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Allow multi-line object description signatures (#11011)TLouf2023-05-112-0/+145
| | | | | 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 the deprecated Setuptools integration (#11363)Adam Turner2023-04-273-202/+0
|
* Add link to Weblate's Sphinx docs in intl documentation (#11332)Maciej Olko2023-04-161-0/+7
| | | Add link to Weblate in intl documentation
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-068-19/+29
| | | | | 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
|
* Fix syntax in ``:manpage:`` role example (#11249)Hugo van Kemenade2023-03-241-1/+1
|
* Normalise spelling of Sphinx versionsAdam Turner2023-03-241-3/+2
|
* Docs: Add a link to sphinx-extensions (#11260)Benjamin Balder Bach2023-03-231-2/+4
|
* 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.
* Remove unicode prefix (``u``) from strings (#11158)Mike Taves2023-02-151-1/+1
|
* Correct the Python Developer Guide markup style advice link (#11189)Hugo van Kemenade2023-02-111-2/+2
|
* Doc of html_file_suffix (closes #11141) (#11144)Jean-François B2023-01-221-2/+2
|
* Documentation reshuffle (#11112)Adam Turner2023-01-081-0/+1
|
* Document autosummary template variable "objtype" (#11044)Tim Hoffmann2023-01-021-0/+6
|
* Fix typos in `usage/configuration.rst` (#10834)Harrissou Sant-anna2023-01-021-3/+3
|
* Docs: Update devguide link (#11017)Hugo van Kemenade2022-12-161-1/+1
| | | Update devguide link
* docs: intl.rst: small fixes while translating (#11020)Jérémie Tarot2022-12-071-9/+9
|
* Fix #10984 [DOC] document latex_additional_files behavior with .tex (#10993)Jean-François B2022-11-301-0/+9
|
* Run the ``pyupgrade`` toolAdam Turner2022-10-172-4/+2
|
* LaTeX: switch to some nicer defaults for tables and code-blocks (#10924)Jean-François B2022-10-171-3/+4
|
* Update documentation of latex builder (#10925)Jean-François B2022-10-171-35/+32
|
* Revert ``html_codeblock_linenos_style`` removal (#10922)Adam Turner2022-10-161-0/+14
|
* Merge branch '5.x'Adam Turner2022-10-166-101/+172
|\ | | | | | | | | | | | | | | # Conflicts: # .github/workflows/main.yml # CHANGES # sphinx/__init__.py # sphinx/domains/c.py
| * s/5.2.0/5.3.0 in various code comments as #10759 got merged in 5.3.0Jean-François B2022-10-121-2/+2
| |
| * LaTeX: support for booktabs-style and zebra-striped tables (#10759)Jean-François B2022-10-124-100/+161
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a combination of 2 + 28 + 7 + and some more commits... * Cherry-pick: Add support for booktabs-style tables to LaTeX builder * Cherry-pick: Add support for zebra-striped tables to LaTeX builder Co-authored-by: Stefan Wiehler <stefan.wiehler@missinglinkelectronics.com> Above work originally initiated by @sephalon (thanks!) Development refactored and continued by @jfbu * latex_table_style configuration, support booktabs, colorrows, borderless Some details: - Simplify a bit a conditional in the longtable template This also puts the target for a longtable with a label but no caption above the toprule for better hyperlinking (testing shows hyperlink target can not end up alone at bottom of previous page). - Extend allowed syntax for colour assignments via 'sphinxsetup' - latex_table_style new configuration value and coloured rows For the user interface I tried to look for inspiration in https://docutils.sourceforge.io/docs/user/config.html#table-style which mentions booktabs and borderless. They also mention captionbelow which we can implement later, now that architecture is here. They don't mention coloured rows. - Test on our own document... looks fine! - Work-around an incompatibility of \cline with row colours - Reverse priority of classes to allow overruling booktabs by standard after parsing source but before letting LaTeX writer act - Closes #8220 Commit https://github.com/sphinx-doc/sphinx/commit/bb859c669679baebd8cc8d10c99382478c0d1647 already improved a bit, this finishes it (as :rst:dir:`rst-class` was actually not linking to anywhere). - Let booktabs style defaults to *not* using \cmidrule. They actually don't make much sense there, as all \hline's are removed. - Add \sphinxnorowcolor which allows construct such as this one in a tabularcolumns directive: >{\columncolor{blue}\sphinxnorowcolor} else LaTeX always overrides column colour by row colour - Add TableMergeColorHeader, TableMergeColorOdd, TableMergeColorEven so single-row merged cells can be styled especially - Extend row colours to all header rows not only the first one (all header rows will share same colour settings) - Auto-adjust to a no '|'-colspec for optimal handling of merged cell - Add \sphinxcolorblend - Workaround LaTeX's \cline features and other grid tables matters - Add \sphinxbuildwarning for important warnings - Fix some white gaps in merged cells of tables with vlines and colorrows - Work around LaTeX's \cline serious deficiencies for complex grid tables This commit corrects \cline badly impacting vertical spacing and making tables look even more cramped as they usually are in LaTeX (although one sees it clearly only with \arrarrulewidth a bit more than the LaTeX default of 0.4pt). Most importantly this commit solves the problem that \cline's got masked by colour panels from the row below. - Update CHANGES for PR #10759 - Improve documentation of new latex_table_style regarding colours
| * Add debug logging to `autosectionlabel` (#10881)Martin Patz2022-10-041-0/+9
| | | | | | Co-authored-by: Martin Patz <martin@recogni.com>
| * Extend cross referencing options with values (#10883)Martin Liška2022-10-021-1/+2
| | | | | | | | | | | | | | | | This change means that text following `=`, `[=`, or ` ` is ignored when searching for a corresponding option directive to an option cross reference role. These are commonly used options, for example `--profile=path`, `--profile[=path]` or `--profile path`. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* | Merge branch '5.x'Adam Turner2022-09-302-8/+43
|\ \ | |/ | | | | | | # Conflicts: # sphinx/locale/__init__.py
| * Merge branch '5.2.x' into 5.xAdam Turner2022-09-302-8/+39
| |\ | | | | | | | | | | | | | | | # Conflicts: # CHANGES # sphinx/__init__.py
| | * Finer grained control over domain ToC entries (#10886)Adam Turner2022-09-302-8/+39
| | | | | | | | | | | | | | | - Implement `:nocontentsentry:` flag - Use `:nocontentsentry:` in docs - Add domain object table of contents configuration option
| * | extend option directive syntaxMartin Liska2022-09-271-0/+4
| |/ | | | | | | One can cross-reference an option value: :option:`--module=foobar`.
* | Drop Python 3.7Adam Turner2022-09-271-1/+1
| |
* | Merge branch '5.x'Adam Turner2022-09-236-83/+142
|\ \ | |/ | | | | | | | | # Conflicts: # setup.py # sphinx/__init__.py
| * imgmath: Allow embedding images in HTML as base64 (#10816)Julien Schueller2022-09-231-0/+6
| | | | | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
| * Add contents entries for domain objects (#10807)Adam Turner2022-09-132-35/+87
| | | | | | | | | | | | | | | | | | - Add entries in the table of contents for domain objects (e.g. `py:function`, `rst:role`, etc). Supported domains are Javascript, Python, and reStructuredText. - Support content in `py:module` and `js:module` directives. - Add the `noindexentry` and `noindex` flags to more domains. - Add `toc_object_entries_show_parents` configuration setting - Update documentation and tests
| * Do not apply epigraph style to all block quotesAdam Turner2022-09-125-48/+49
| | | | | | | | | | | | | | Correct indentation where appropriate for stanzas that should not be rendered as `<blockquote>` HTML elements. Closes GH-10686
* | Merge branch '5.x'Jean-François B2022-08-061-2/+0
|\ \ | |/
| * Remove extra line (#10749)Abdur-Rahmaan Janhangeer2022-08-041-2/+0
| | | | | | Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
* | Merge branch '5.x'Adam Turner2022-07-241-3/+0
|\ \ | |/ | | | | | | | | # Conflicts: # CHANGES # sphinx/__init__.py
| * Update include_patterns implementation (#10680)Adam Turner2022-07-231-3/+0
| |
* | Merge branch '5.x'Takeshi KOMIYA2022-07-232-3/+3
|\ \ | |/
| * Fix indentation of .. version{changed,added}.marxin2022-07-192-3/+3
| |
* | Merge branch '5.x'Adam Turner2022-07-182-3/+3
|\ \ | |/ | | | | | | | | # Conflicts: # sphinx/ext/autodoc/__init__.py # sphinx/writers/html5.py
| * Update documentation structure and theming (#10677)Chris Holdgraf2022-07-182-3/+3
| | | | | | Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
* | Merge branch '5.x'Adam Turner2022-07-171-4/+23
|\ \ | |/
| * Add `include_patterns` as the opposite of `exclude_patterns` (#10518)Adam Turner2022-07-171-4/+23
| |
View Lorry Controller Status