| Commit message (Collapse) | Author | Age | Files | Lines |
... | |
| |
|
|\
| |
| |
| |
| |
| |
| |
| | |
# Conflicts:
# .github/workflows/main.yml
# CHANGES
# sphinx/__init__.py
# sphinx/domains/c.py
|
| | |
|
| |
| |
| |
| |
| |
| |
| |
| | |
Without this change, local images with `#` in their name result in incorrect URLs
There is already a similar call to `urllib.parse.quote` for file downloads, suggesting this is a sensible approach.
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
|
| |
| |
| |
| |
| |
| |
| | |
This reverts commit b1390c4191319e75d14ce3e6e73ef43c31d981b4.
The change is reverted because some builders don't have
fine-grained support for outdated docs:
https://github.com/sphinx-doc/sphinx/issues/10903#issuecomment-1273199352
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
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
|
| | |
|
| |
| |
| | |
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
|
| |
| |
| |
| |
| |
| |
| |
| | |
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>
|
|\ \
| |/
| |
| |
| | |
# Conflicts:
# sphinx/locale/__init__.py
|
| |\
| | |
| | |
| | |
| | |
| | | |
# Conflicts:
# CHANGES
# sphinx/__init__.py
|
| | | |
|
| | |
| | |
| | |
| | | |
One can cross-reference an option value: :option:`--module=foobar`.
|
| | | |
|
| | | |
|
| | | |
|
| | | |
|
|\ \ \
| |/ / |
|
| |/
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
We already have a helper function that allows us to convert a filename
to a "docname". Don't reinvent the wheel and simply use this when
building specific files with Sphinx. Note that this does change behavior
slightly, insofar as filenames that don't resolve to valid docnames will
now be ignored rather than being passed with their suffix and silently
ignored later, but that seems sane.
Signed-off-by: Stephen Finucane <stephen@that.guru>
|
|\ \
| |/
| |
| |
| |
| |
| |
| |
| |
| | |
# Conflicts:
# CHANGES
# doc/conf.py
# sphinx/__init__.py
# sphinx/builders/html/__init__.py
# sphinx/domains/python.py
# tests/test_build_html.py
|
| |
| |
| |
| | |
- Ensure `pycon3` is always normalised to `pycon`
|
| | |
|
| | |
|
| | |
|
|\ \
| |/
| |
| |
| |
| | |
# Conflicts:
# setup.py
# sphinx/__init__.py
|
| |
| |
| | |
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
|
| | |
|
| |
| |
| |
| |
| |
| |
| |
| |
| | |
- 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
|
| |
| |
| |
| |
| |
| | |
The `.. toctree::` directive now supports the reserved special docnames
'genindex', 'modindex', and 'search'.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
|
|\ \
| |/
| |
| |
| |
| |
| |
| |
| | |
# Conflicts:
# setup.py
# sphinx/application.py
# sphinx/environment/__init__.py
# sphinx/ext/autodoc/directive.py
# tests/test_build_html.py
|
| | |
|
| |
| |
| | |
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
|
| | |
|
| | |
|
| |
| |
| | |
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
|
| |
| |
| |
| |
| |
| | |
Add raw directives' source URL to the list of links to check with linkcheck.
By the way, refactor HyperlinkCollector by adding `add_uri` function.
Add test for linkcheck raw directives source URL
|
|\ \
| |/ |
|
| |
| |
| | |
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
|
| |\ |
|
| | | |
|
| | | |
|
| | |
| | |
| | |
| | | |
Specifically 'template<int (X::*)(bool)...>'
|
| | | |
|
| | |
| | |
| | |
| | |
| | | |
Previously, in certain cases the template arguments of
non-specializations were retained, leading to incorrect merging of symbols.
|
|\ \ \
| |/ / |
|
| | | |
|
| | | |
|
| | | |
|
| |/
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
Previously a C++20 requires-clause was only supported on `function`
declarations. However, the C++ standard allows a require-clause on
class/union templates, alias templates, and variable templates, and
also allows a requires clause after each template parameter list, not
just the final one.
This moves the requiresClause to be a property of `ASTTemplateParams`
rather than `ASTDeclaration` to better match the C++ grammar and
allows requires clauses in many places that are supported by C++20 but
were not previously allowed by Sphinx, namely:
- On class templates, alias templates, and variable templates
- After each template parameter list, not just the last one.
- After the template parameter list in template template parameters.
When encoding the id, the requires clause of the last template
parameter list is treated specially in order to preserve compatibility
with existing v4 ids.
|
|\ \
| |/
| |
| |
| |
| | |
# Conflicts:
# CHANGES
# sphinx/__init__.py
|