Commit Graph

3553 Commits

Author SHA1 Message Date
marxin
9a30edac7d Fix indentation of .. version{changed,added}. 2022-07-19 15:26:57 +02: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
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
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
Jean-François B
6afde2e301 LaTeX: refactor sphinxShadowBox to allow colors for frame and shadow 2022-06-30 22:40:47 +02: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
Adam Turner
ea14dd533b Fix inline literal markup in templating.rst 2022-06-16 23:15:50 +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
Martin Liška
f789148fa2 Allow emphasising placeholders in option directives (#10366)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-06-16 20:46:01 +01:00
Adam Turner
881f66c557 Simplify Sphinx's Stemmer (#10467) 2022-06-16 19:47:09 +01:00
Julien Palard
956cddb7d4 Replace doclinter with sphinx-lint (#10389)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-06-16 19:32:09 +01:00
Takeshi KOMIYA
4d7558e968 Merge branch '5.0.x' into 5.x 2022-06-17 02:19:33 +09:00
Adam Turner
5806f0af27 Add nav.contents everywhere that div.topic is used 2022-06-07 23:12:29 +01:00
Adam Turner
334572383e Merge remote-tracking branch 'upstream/5.0.x' into fix-double-brackets
# Conflicts:
#	CHANGES
2022-06-06 15:27:55 +01:00
Adam Turner
5ddc22baf8 Fix an example in the templating document
Co-authored-by: Matthias Geier <Matthias.Geier@gmail.com>
2022-06-04 20:53:57 +01:00
Adam Turner
7286291f93 Add docutils_version_info to StandaloneHTMLBuilder.globalcontext 2022-06-04 18:08:33 +01:00
Adam Turner
fbd374859a Add aside.topic for Docutils 0.18+ (sphinx13) 2022-06-04 17:09:44 +01:00
Takeshi KOMIYA
e1bf4dd5d5 Merge branch '5.0.x' into 5.x 2022-05-29 16:38:05 +09:00
Adam Turner
78c478a579 Merge remote-tracking branch 'upstream/5.0.x' into lang-none-en 2022-05-28 19:21:44 +01:00
Takeshi KOMIYA
68252c646a doc: The default setting of "language" has been changed since v5.0 2022-05-28 19:09:35 +01:00
Takeshi KOMIYA
f7a88441bf Merge branch '5.0.x' into 5.x 2022-05-28 23:18:00 +09:00
Takeshi KOMIYA
004012b6df Merge branch '4.x' into 5.0.x 2022-05-28 23:17:46 +09:00
Takeshi KOMIYA
e7ab472b6d Merge branch '4.5.x' into 4.x 2022-05-28 23:16:54 +09:00
Takeshi KOMIYA
06436084dd Merge pull request #10464 from tk0miya/10461_doc_code-block_class_option
doc: Add an explanation for :class: option of code-block directive
2022-05-28 23:15:08 +09:00
Takeshi KOMIYA
721bc00d2b Update URL for requests 2022-05-28 23:04:55 +09:00
Takeshi KOMIYA
4c664ae0b8 Merge branch '5.0.x' into 5.x 2022-05-23 02:07:24 +09:00
Takeshi KOMIYA
cab2d93076 Merge pull request #10386 from mxd4/10384-comment-img-magick
Add comments on ImageMagick requirement
2022-05-22 19:22:24 +09:00
Takeshi KOMIYA
1856ee638b Close #10461: doc: Add an explanation for :class: option of code-block directive 2022-05-22 16:03:33 +09:00
Takeshi KOMIYA
e6f07c7381 doc: Fix syntax error
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-05-22 13:34:21 +09:00
Takeshi KOMIYA
c63d4741e9 Fix #10344: docs: Update explanation for copying static files manually 2022-05-15 23:38:01 +09:00
Takeshi KOMIYA
f9dce5764e Mark sphinx.io:read_doc() deprecated 2022-05-08 02:15:58 +09:00
Takeshi KOMIYA
425a3e6c09 Merge branch '4.x' into 5.x 2022-05-06 03:32:43 +09:00
Takeshi KOMIYA
3805e0646f Merge pull request #10251 from jbms/fix-inline-syntax-highlight
Make code role highlighting consistent with code-block directive
2022-05-06 02:54:42 +09:00
Takeshi KOMIYA
21fb2caad6 Merge pull request #10412 from tk0miya/deprecate_sphinx.util.docutils.__version_info__
Remove sphinx.util.docutils.__version_info__ on 7.0
2022-05-05 19:46:58 +09:00
Takeshi KOMIYA
e4f78df2fc Merge pull request #10345 from Thecarisma/fix-theming-add-static-file-documentation
Refractor the example in 'Add your own static files to the build assets' documentation section
2022-05-03 02:10:57 +09:00
Takeshi KOMIYA
be212d98df Remove sphinx.util.docutils.__version_info__ on 7.0 2022-05-03 02:07:47 +09:00
Takeshi KOMIYA
8e726db3de Merge pull request #10381 from tk0miya/deprecation_for_docutils-0.13
Mark APIs for docutils-0.13 deprecated and remove monkey-patch for it
2022-05-03 02:06:13 +09:00
Takeshi KOMIYA
538fdb23bb Merge pull request #10388 from soxofaan/patch-1
sphinx.ext.napoleon docs: fix Google style link
2022-05-03 01:53:58 +09:00
Takeshi KOMIYA
3aa7e4105a Deprecate: html5_ready and is_html5_writer_available() 2022-05-03 01:48:17 +09:00
Adam Turner
971040b4b7 Merge branch '5.x' into fix-warnings
# Conflicts:
#	tests/test_search.py
2022-05-02 17:05:42 +01:00
Takeshi KOMIYA
b58a584236 Merge pull request #10164 from AA-Turner/bump-docutils
Bump Docutils dependency
2022-05-03 01:00:51 +09:00
mxd4
33b5e23467 #10384 - Grammar 2022-05-02 13:56:51 +02:00