IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
19,643 Commits 2 Branches 219 Tags
3c73efadab5cf0e4be94eeadd91f3e9c0eb2996e
Commit Graph

3573 Commits

Author SHA1 Message Date
Martin Liska
29e6adab12 extend option directive syntax 
One can cross-reference an option value: :option:`--module=foobar`.
 2022-09-27 19:02:45 +01:00
King Phyte
061c8ad528 fix typo in extrapackages example (#10835) 
Co-authored-by: Jean-François B <2589111+jfbu@users.noreply.github.com>
 2022-09-27 18:01:34 +02:00
Jean-François B
a34a34fe53 Mumble (line too long but this is raw LaTeX, and we should be exempted) 2022-09-24 23:17:34 +02:00
Jean-François B
464d0815e9 [DOC] Avoid collisions in TOC of sphinx.pdf in Changelog chapter 
Relates #10858
 2022-09-24 23:09:31 +02:00
Jean-François B
89a656dec4 LaTeX: improved doc of \sphinxtableofcontents (closes #10858) 2022-09-24 22:32:07 +02:00
Adam Turner
c7c0e4048d Split out sphinx_highlight.js 2022-09-24 15:10:57 +01:00
Adam Turner
58a4449707 Deprecate HTML 4 support (#10843) 2022-09-23 18:12:54 +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
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
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
e3337c78c6 Update include_patterns implementation (#10680) 2022-07-23 21:19:35 +01:00
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