| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| | |
|
| |
|
|
|
| |
Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
|
| |
|
|
|
|
|
| |
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
|
| | |
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
This is for the table of the Websupport.get_data() auto-documentation.
Somethink similar perhaps \setlength{\tymin}{1.5cm} at least could be a
global default; the only reason we have not changed it yet is that
perhaps some tables in user projects use really short contents such as
letter.
(what we would want to avoid is narrow columns allowed by hyphenation of
single words; maybe some thinking needed here as \sphinxAtStartPar
renders this hyphenation possible but perhaps even upstream LaTeX has
now made hyphenation of single words work in table cells).
|
| | |
|
| | |
|
| |\
| |
| |
| |
| |
| |
| |
| | |
# Conflicts:
# .github/workflows/main.yml
# CHANGES
# sphinx/__init__.py
# sphinx/domains/c.py
|
| | | |
|
| | |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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
|
| |\ \
| |/
| |
| |
| |
| |
| |
| |
| |
| | |
# Conflicts:
# CHANGES
# doc/conf.py
# sphinx/__init__.py
# sphinx/builders/html/__init__.py
# sphinx/domains/python.py
# tests/test_build_html.py
|
| | | |
|
| |\ \
| |/ |
|
| | |\
| | |
| | | |
LaTeX: box padding (t,r,b,l), borders (t,r,b,l), shadows (x,y) or radii
|
| | | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | | |
- 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
|
| |\ \ \
| |/ / |
|
| | |/ |
|
| | |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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.
|
| | | |
|
| | |
| |
| |
| |
| | |
To make RtD search available, this adds jQuery patches on old Sphinx to
sphinx-doc.org.
|
| | |
| |
| |
| |
| | |
Since 6.0, jQuery has not been loaded by default. It affects to the
search feature of RtD. This loads jQuery again to make it available.
|
| |/ |
|
| |\ |
|
| | | |
|
| | | |
|
| |\ \
| |/ |
|
| | | |
|
| | | |
|
| |\ \
| |/ |
|
| | | |
|
| |\ \
| |/ |
|
| | | |
|
| |\ \
| |/ |
|
| | |
| |
| |
| |
| |
| | |
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.
|
| |\ \
| |/ |
|
| | |
| |
| |
| |
| | |
Seems like that link is used in some tests and code so
upgrading it outside documentation might break something
|
| | |
| |
| |
| |
| | |
Also change any docutils.sourceforge.net link to io
top level domain.
|
| |/
|
|
|
|
| |
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.
|
| |\ |
|
| | | |
|
| | |
| |
| |
| |
| |
| | |
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.
|
| |/
|
|
| |
Add bookmarksdepth key to latex_elements['sphinxsetup']
|
| |\ |
|
| | | |
|
| |/
|
|
|
|
|
| |
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.
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| |
|
|
|
|
|
| |
.. 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
|
| |
|
|
|
| |
Follow the Retry-After header if present, otherwise use an exponential
back-off.
|
| |
|
|
|
|
|
|
|
|
|
|
| |
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.
|
| | |
|
