Commit Graph

3588 Commits

Author SHA1 Message Date
Adam Turner
56aa3412ef Merge branch '5.x'
# Conflicts:
#	setup.py
#	sphinx/__init__.py
2022-09-23 17:27:00 +01:00
Julien Schueller
ef01c5b6bd imgmath: Allow embedding images in HTML as base64 (#10816)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2022-09-23 17:11:21 +01:00
danieleades
276f430b57 Begin addding flake8-simplify checks (#10820)
Start with SIM104 and ignore all other flake8-simplify warnings
2022-09-20 21:30:31 +01:00
Adam Turner
f57177de89 Add contents entries for domain objects (#10807)
- 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
2022-09-13 20:20:02 +01:00
Adam Turner
ee005caf22 Do not apply epigraph style to all block quotes
Correct indentation where appropriate for stanzas that should not be
rendered as `<blockquote>` HTML elements.

Closes GH-10686
2022-09-12 19:54:36 +01:00
Adam Turner
14c9b40f15 Merge branch '5.x'
# Conflicts:
#	setup.py
#	sphinx/application.py
#	sphinx/environment/__init__.py
#	sphinx/ext/autodoc/directive.py
#	tests/test_build_html.py
2022-09-09 09:58:24 +01:00
Tim Hoffmann
5951de4086 sphinx13.css: add left padding to the footer (#10789) 2022-08-28 01:33:26 +01:00
Jean-François B
caf4357cdc Merge pull request #10752 from dstansby/patch-1
Fix small typo in extension hello world tutorial
2022-08-07 15:15:29 +02:00
Adam Turner
7ef46150d1 Update doc/development/tutorials/helloworld.rst 2022-08-07 10:16:39 +01:00
Jean-François B
5c82449eca Merge branch '5.x' 2022-08-06 18:31:14 +02:00
Abdur-Rahmaan Janhangeer
59056aa781 Remove extra line (#10749)
Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
2022-08-04 18:42:55 +02:00
David Stansby
26ca57893d Fix small typo in extension hello world tutorial 2022-08-04 16:48:24 +01:00
Jean-François B
f72a25ce76 Merge branch '5.1.x' into 5.x 2022-08-01 21:05:47 +02:00
daniel.eades
964fcb2e07 Fix flake8 5.0.0 reported formatting errors 2022-08-01 20:55:47 +02:00
eloyvallinaes
2800db0b70 Update deploying.rst
Version 0.4 of sphinx-action contains a problem investigated and documented here: https://github.com/ammaraskar/sphinx-action/issues/5. The action throws an error claiming it can't write the log file. The problem is fixed in master and since this is a tutorial, it is more or less expected that it should work off the bat, so I thinking pinning the master version for now and the next release when it comes out, might be the best way to help newbies.
2022-07-26 11:17:53 +02:00
Adam Turner
19b54dce6a Merge branch '5.x'
# Conflicts:
#	CHANGES
#	sphinx/__init__.py
2022-07-24 14:15:26 +01:00
Adam Turner
e3337c78c6 Update include_patterns implementation (#10680) 2022-07-23 21:19:35 +01:00
Takeshi KOMIYA
4f072b02ed Merge pull request #10690 from ericholscher/patch-3
Note that the tutorial is a tutorial, to help with search
2022-07-24 03:21:33 +09:00
Takeshi KOMIYA
1199f7bd75 Merge branch '5.x' 2022-07-23 15:32:38 +09:00
Eric Holscher
7a9f22d661 Note that the tutorial is a tutorial, to help with search 2022-07-21 15:12:18 -07:00
marxin
9a30edac7d Fix indentation of .. version{changed,added}. 2022-07-19 15:26:57 +02:00
Adam Turner
94024e6efa Merge branch '5.x'
# Conflicts:
#	sphinx/ext/autodoc/__init__.py
#	sphinx/writers/html5.py
2022-07-18 22:49:56 +01:00
Chris Holdgraf
eb0a6c574f Update documentation structure and theming (#10677)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2022-07-18 22:48:28 +01:00
Adam Turner
a4d41aa889 Merge branch '5.x' 2022-07-17 21:53:12 +01:00
Adam Turner
490a8a9162 Add include_patterns as the opposite of exclude_patterns (#10518) 2022-07-17 21:44:33 +01:00
Takeshi KOMIYA
e7fc03bce2 Allow specifying multiple CSS files in themes (#10465)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2022-07-17 12:27:43 +01:00
Jean-François B
d737608591 Merge pull request #10648 from jfbu/latex_enhancedboxes
LaTeX: box padding (t,r,b,l), borders (t,r,b,l), shadows (x,y) or radii
2022-07-14 11:19:48 +02:00
Jean-François B
64647ca55f LaTeX: enhanced boxes with padding, borders, shadows, rounded corners
- 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
2022-07-14 11:08:28 +02:00
Adam Turner
1e3ade55fe Merge branch '5.x' 2022-07-10 23:05:23 +01:00
Adam Turner
9112cfeb8d Refresh the Sphinx13 theme (#10652) 2022-07-10 22:48:15 +01:00
Jean-François B
4dbb62b9cd LaTeX: optional rounded corners for framing of code-blocks
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.
2022-07-05 09:56:40 +02:00
Takeshi KOMIYA
3d175d9a24 Merge branch '5.x' 2022-07-03 22:40:34 +09:00
Jean-François B
6afde2e301 LaTeX: refactor sphinxShadowBox to allow colors for frame and shadow 2022-06-30 22:40:47 +02:00
Jean-François B
80198e82aa Merge branch '5.x' into master
Resolved merge conflicts:
    sphinx/ext/extlinks.py
    sphinx/ext/napoleon/docstring.py
    (and removed from the latter a now unused import for flake8 F401
    compliance)
2022-06-30 15:00:16 +02:00
Adam Turner
ac0fc4b781 Remove more deprecated items in Sphinx 6.0 (#10562) 2022-06-26 15:01:09 +01:00
Antony Lee
03c1e1b15c Replace napoleon.iterators by simpler stack implementation (#9856) 2022-06-26 12:40:42 +01:00
jfbu
d730c55f13 [DOC] Fix sectioning level in usage/configuration.rst
The conf.py example ended up as sub-section of previous one
2022-06-26 11:36:38 +02:00
jfbu
f74cc3fcaa Minor cross-linking improvements in usage/restructuredtext/roles.rst 2022-06-26 09:51:39 +02:00
jfbu
8ecbe8a15a Improve mark-up in docs (follow-up to PR #10366) 2022-06-26 09:30:22 +02:00
Brecht Machiels
7b0787485e Fix link to rinohtype manual (#10593) 2022-06-22 19:35:42 +01:00
Adam Turner
b26bf0320c Add underscore.js to the sphinx13 theme (#10588) 2022-06-19 23:12:38 +01:00
Takeshi KOMIYA
4292630965 Fix #10574: Failed to search on sphinx-doc.org (again) 2022-06-19 22:47:41 +09:00
Takeshi KOMIYA
521a47b033 Fix #10574: Failed to search on sphinx-doc.org (again)
To make RtD search available, this adds jQuery patches on old Sphinx to
sphinx-doc.org.
2022-06-19 19:26:18 +09:00
Takeshi KOMIYA
a06c49105b Fix #10574: Failed to search on 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.
2022-06-19 18:35:45 +09:00
Adam Turner
fcc238a21d Merge branch '5.x' 2022-06-16 23:17:42 +01:00
Adam Turner
ea14dd533b Fix inline literal markup in templating.rst 2022-06-16 23:15:50 +01:00
Adam Turner
7e38d2dad8 Merge branch '5.x'
# Conflicts:
#	.github/workflows/builddoc.yml
#	.github/workflows/lint.yml
#	sphinx/registry.py
2022-06-16 21:46:54 +01:00
Adam Turner
6ab15a047c Update GitHub Actions versions (#10561) 2022-06-16 21:43:00 +01:00
Adam Turner
70f950cae0 Remove traces of Python 2 and 3.5 (#10560) 2022-06-16 21:37:46 +01:00
Adam Turner
ce31e1c0c7 Remove deprecated items for Sphinx 6.0 (#10471) 2022-06-16 21:05:37 +01:00