summaryrefslogtreecommitdiff
path: root/doc/extdev
Commit message (Collapse)AuthorAgeFilesLines
* Remove the deprecated Setuptools integration (#11363)Adam Turner2023-04-271-1/+1
|
* Note correct deprecation version for ``sphinx.util.osutil.cd``Adam Turner2023-04-231-1/+1
|
* Enable 'nit-picky mode' for Sphinx's documentationAdam Turner2023-04-063-14/+14
| | | | | Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
* Normalise spelling of Sphinx versionsAdam Turner2023-03-241-2/+2
|
* Prefer ``contextlib.chdir`` to ``sphinx.util.osutil.cd``Adam Turner2023-03-051-0/+5
|
* Documentation reshuffle (#11112)Adam Turner2023-01-081-2/+2
|
* Fix deprecation warningsAdam Turner2023-01-051-1/+0
|
* Move exception formatting utilities to ``sphinx.util.exceptions``Adam Turner2023-01-031-0/+10
|
* Move HTTP-date formatting utils to `utils.http_date`Adam Turner2023-01-031-0/+10
|
* Move console output utilities to ``sphinx.util.display``Adam Turner2023-01-031-0/+20
| | | | | - Merge `old_status_iterator` into ``status_iterator``. ``old_status_iterator`` was deprecated in version 1.6.
* Use PEP 604 display for ``typing.Optional`` and ``typing.Union`` (#11072)Adam Turner2023-01-021-0/+5
|
* Update removal note for logo and favicon variables (#11063)Viktor Haag2022-12-311-2/+2
| | | These were removed in Sphinx 6.0.0
* LaTeX: support for booktabs-style and zebra-striped tables (#10759)Jean-François B2022-10-121-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Deprecate HTML 4 support (#10843)Adam Turner2022-09-231-0/+5
|
* Add contents entries for domain objects (#10807)Adam Turner2022-09-131-0/+1
| | | | | | | | | - 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-121-28/+28
| | | | | | | Correct indentation where appropriate for stanzas that should not be rendered as `<blockquote>` HTML elements. Closes GH-10686
* Add `include_patterns` as the opposite of `exclude_patterns` (#10518)Adam Turner2022-07-171-0/+10
|
* Replace `napoleon.iterators` by simpler stack implementation (#9856)Antony Lee2022-06-261-0/+5
|
* Simplify Sphinx's Stemmer (#10467)Adam Turner2022-06-161-0/+5
|
* Replace doclinter with sphinx-lint (#10389)Julien Palard2022-06-161-1/+1
| | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* Mark sphinx.io:read_doc() deprecatedTakeshi KOMIYA2022-05-081-0/+5
|
* Remove sphinx.util.docutils.__version_info__ on 7.0Takeshi KOMIYA2022-05-031-0/+5
|
* Deprecate: html5_ready and is_html5_writer_available()Takeshi KOMIYA2022-05-031-0/+10
|
* Schedule removal for 7.0Adam Turner2022-04-301-1/+1
|
* Deprecate `sphinx.util.jsdump`Adam Turner2022-04-271-0/+5
|
* fix typoTakayuki SHIMIZUKAWA2022-04-191-1/+1
| | | from https://github.com/sphinx-doc/sphinx-doc-translations/pull/13
* Merge branch '4.x'Takeshi KOMIYA2022-03-271-0/+1
|\
| * doc: Update docs for sphinx.parsers.ParserTakeshi KOMIYA2022-03-271-0/+1
| |
* | Merge branch '4.x'Takeshi KOMIYA2022-02-191-0/+5
|\ \ | |/
| * Fix #10181: napoleon_use_ivar adds unexpected prefix to varsTakeshi KOMIYA2022-02-121-0/+5
| | | | | | | | | | | | | | | | Since 4.0, :ivar: items has not been rendered as hyperlinks. So any modules, classes and tilda are now harmful. This removes the prefixing filter for napoleon_use_ivar option. refs: #5129 and #5977
* | Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9'Takeshi KOMIYA2022-02-141-1/+3
|\ \ | |/
| * Mention nitpick_ignore(_regex) in docs of warn-missing-referenceHinrich Mahler2022-01-181-1/+3
| |
* | Close #10062: Change the default language to 'en'Takeshi KOMIYA2022-01-121-0/+10
| | | | | | | | | | Change the default language to `'en'` if any language is not set in `conf.py`.
* | Close #9595: Deprecate setuptools integrationTakeshi KOMIYA2022-01-011-0/+5
| |
* | Deprecate sphinx.writers.latex.LaTeXWriter.docclassesTakeshi KOMIYA2021-12-181-0/+5
|/
* Fix #9752: autodoc: Failed to detect type annotation for slots attributeTakeshi KOMIYA2021-10-231-0/+5
|
* Fix #9710: html: Wrong styles for even/odd rows in nested tablesTakeshi KOMIYA2021-10-091-0/+20
|
* Merge branch '4.x' into 9683_add_css_fileTakeshi KOMIYA2021-10-091-0/+5
|\
| * js nodes, docs, add entry in deprecation/removal tableJakob Lykke Andersen2021-10-031-0/+5
| |
* | Close #9683: Revert the removal of ``add_stylesheet()`` APITakeshi KOMIYA2021-10-031-1/+1
|/ | | | | | | It will be kept until the Sphinx-6.0 release. Note: Now it emits a warning instead of DeprecationWarning to let the users know the deprecation.
* Merge pull request #9666 from tk0miya/9662_docs_for_ObjectDescriptionTakeshi KOMIYA2021-09-271-0/+4
|\ | | | | Add doc for ObjectDescription (refs: #9662)
| * Add doc for ObjectDescription (refs: #9662)Takeshi KOMIYA2021-09-231-0/+4
| |
* | Fix #9637: Add Builder.allow_parallel to the list of builder APIsTakeshi KOMIYA2021-09-181-0/+1
|/
* Fix typoEisuke Kawashima2021-07-081-2/+2
|
* Merge branch '4.0.x' into 4.xTakeshi KOMIYA2021-06-301-1/+1
|\
| * Revert the removal of sphinx.util:force_decode()Takeshi KOMIYA2021-06-131-1/+1
| | | | | | | | | | | | | | | | | | | | After the release of 4.0.0, some 3rd party extensions have became not working with the latest Sphinx because `force_decode()` function was removed. It was deprecated since Sphinx-2.0 and warned for the removal since 3.0. This reverts the removal and extends its deprecation period to 5.0.0. I hope it helps users of these extensions.
* | Fix #9032: docs: sphinx.environment.NoUri was removed at v3.0.0Takeshi KOMIYA2021-06-141-1/+2
| | | | | | | | | | Our deprecation list describes `sphinx.environment.NoUri` was removed at v4.0.0. But, acutally, it was removed at v3.0.0 (#6223).
* | Merge pull request #9303 from tk0miya/fix_docslintTakeshi KOMIYA2021-06-061-5/+8
|\ \ | | | | | | doc: Fix docslint misunderstanding scope of code-blocks
| * | doc: Fix docslint misunderstanding scope of code-blocksTakeshi KOMIYA2021-06-061-5/+8
| | |
* | | Merge pull request #9260 from tk0miya/9016_linkcheck_github_anchorsTakeshi KOMIYA2021-06-041-0/+8
|\ \ \ | |/ / |/| | Close #9016: linkcheck builder failed to check the anchors of github.com
View Lorry Controller Status