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
21,214 Commits 2 Branches 219 Tags 163 MiB
fadb6b10cb
Commit Graph

175 Commits

Author SHA1 Message Date
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
89a656dec4 LaTeX: improved doc of \sphinxtableofcontents (closes #10858) 2022-09-24 22:32:07 +02: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
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
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
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
Christian Clauss
86583c578c Fix typos discovered by codespell 2021-09-08 02:15:25 +02:00
jfbu
af5363cefb LaTeX: add some documentation for container support (#9166) 2021-07-19 12:10:15 +02:00
Takeshi KOMIYA
7e3e15231e
Merge pull request #9419 from zhsj/fancyvrb-zh 
Add xeCJKVerbAddon to default fvset config for Chinese documents
 2021-07-11 01:43:44 +09:00
Shengjing Zhu
92c9cabae5 Add xeCJKVerbAddon to default fvset config for Chinese documents 
Prevent xeCJK from adding extra spaces in fancyvrb Verbatim enviroment.

Fixes: #9414

Signed-off-by: Shengjing Zhu <i@zhsj.me>
 2021-07-09 01:53:52 +08:00
Eisuke Kawashima
652ebf1bf5
Fix typo 2021-07-08 08:16:22 +09:00
jfbu
9dbf2c9a98 Closes: #9321 (LaTeX utf8x usage doc) 2021-06-13 12:29:39 +02:00
Takeshi KOMIYA
cb78512835 doc: Fix minor mark-up misses up 2021-04-24 18:37:30 +09:00
jfbu
ddef4950ee LaTeX: let bookmarks use high default depth 
Add bookmarksdepth key to latex_elements['sphinxsetup']
 2021-02-18 13:11:28 +01:00
jfbu
b9c53c8ca6 Merge branch '3.x' into merge_3.x_into_master 
Resolved Conflicts:
	sphinx/texinputs/sphinx.sty

Some hunks needed to go to sphinx/texinputs/sphinxlatexliterals.py,
others already belonged to split files.
 2021-02-09 19:03:38 +01:00
jfbu
87d0b15eab Also indent warning to not interrupt description list 2021-02-09 18:29:56 +01:00
jfbu
a310c4c5b6 Indent note directive inside list item 2021-02-09 18:25:37 +01:00
jfbu
32d8b4e445 Minor refactoring in doc/latex.rst 2021-02-09 18:11:24 +01:00
Jean-François B
1c08467040
Merge pull request #8851 from jfbu/latex_enhance_docs_about_index 
LaTeX: improve docs of 'printindex' and 'makeindex'
 2021-02-09 16:16:26 +01:00
jfbu
aaac721104 Typo 2021-02-09 16:04:01 +01:00
jfbu
035d13fd24 Update CHANGES and docs relative to new verbatimforcewraps 2021-02-09 15:47:15 +01:00
jfbu
eee17ff61a Fix forgotten link to Pygments home site, mmmmpf 2021-02-09 12:33:16 +01:00
jfbu
abddafa98a Fix inexistent directive "notice", it is "note"... 2021-02-09 12:28:03 +01:00
jfbu
c6a8fb1625 Add verbatimmaxoverfull and verbatimmaxunderfull 2021-02-09 12:18:31 +01:00
jfbu
0076ad3fd3 Indicated force wrapping code lines is fragile with Unicode input 2021-02-09 00:01:39 +01:00
jfbu
702545da1c LaTeX: optionally apply a second forceful wrapping of long code lines 
Closes #8849
 2021-02-08 23:13:46 +01:00
jfbu
a984f5f7cc LaTeX: improve docs of 'printindex' and 'makeindex' 
Closes #8055
 2021-02-08 14:59:20 +01:00
jfbu
c07adc4ebb Fix docs markup from d6e11b89 
Sorry that I fixed this in master already, forgetting it was initially
merged into 3.x.
 2021-01-30 21:17:07 +01:00
jfbu
6dea091257 Fix markup in docs (from d6e11b89) 2021-01-30 21:14:02 +01:00
Takeshi KOMIYA
339ce2f894 Merge branch '3.x' 2021-01-30 11:49:08 +09:00
jfbu
d6e11b89e9 Fix suppression of needed whiteline, encapsulate into \sphinxAtStartPar 
Define it to do nothing with lualatex engine
 2021-01-29 10:40:50 +01:00
jfbu
6e80d27841 Refactor LaTeX [1/2]: split sphinx.sty into separate components 
The latex macros from sphinx.sty were already partitioned into
successive sections.  The file sphinx.sty is split into multiple
files in concordance with this pre-existing sectioning.

The files are loaded via \input. File extension is .sty not .tex
to not confuse the Makefile.
 2021-01-27 15:58:48 +01:00
Takeshi KOMIYA
502c4ee5fb Merge branch '3.x' 2021-01-24 14:32:13 +09:00
jfbu
2e22bd0a23 Merge branch 'master' into latex_font_for_pdflatex 2021-01-23 09:13:08 +01:00
Takeshi KOMIYA
9a905ce547
Merge pull request #8724 from jfbu/latex_fancyboxissue 
Closes: #8339
 2021-01-23 16:47:21 +09:00
jfbu
11e7feb6fa Closes: #8339 
Handled as only a documentation issue.
 2021-01-21 19:51:59 +01:00
jfbu
99a8b7f37f LaTeX: update default font configuration 
This replaces times package with tgtermes and tgheros (clones of Times and
Helvetica with better LaTeX support) and the monospace font from txfonts
package (txtt). This font is better matched with Times-like fonts than
Courier clones.

The changes applies to pdflatex/platex/uplatex.

Fixes: #8711
 2021-01-20 23:03:08 +01:00
jfbu
59694da63a Fix some mark-up issues in latex.rst with "Default:" lines 2021-01-20 21:15:52 +01:00
Stephen Finucane
f3360e6922 docs: Fix typo, replace field lists with paragraphs 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:43:05 +01:00
Stephen Finucane
52bb0b02bb docs: Fix a typo and some indentation 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:23:36 +01:00
Stephen Finucane
ceb72f9cd7 doc: Rework "latex" document 
Remove some unnecessary indentation, consistently document option
defaults, and fix some wrapping and whitespace.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:23:36 +01:00
Takeshi KOMIYA
6e83f0dcb3 doc: fix a versionchnaged to correct one 2020-03-05 23:46:58 +09:00
Jesse Tan
7c1b673076 Add LaTeX styling hook for :kbd: role 2020-01-09 16:35:40 +01:00
jfbu
73a2228c87 Update 'fontenc' latex_elements key documentation 2019-12-07 12:27:21 +01:00
jfbu
a550c7075f LaTeX: Allow linebreaks at \ (in literals, code-blocks, parsed-literal) 
Default configuration is to allow the linebreak after the backslash.
It is possible at user side via 'preamble' key and some LaTeX code
to allow the linebreak before the backslash, but each of inline-literal,
code-block, and parsed-literal has its more or less cumbersome way for
that.

Closes: #6000, #6001

This commit handles only the \ character, which had been left aside
by accident so far. Inline-literals could break at more characters
but this is not yet done in this commit. In this context, in future
it could be useful to modify sphinx.util.texescape to use mark-up
such as \sphinxtextbackslash rather than naked \textbackslash and
similarly for some other characters. This could then be used to
allow linebreaks even in regular text paragraphs.
 2019-11-06 18:59:09 +01:00
Takeshi KOMIYA
4ec563fcff Close #6762: latex: Allow to load additonal LaTeX packages 2019-11-05 22:25:41 +09:00
jfbu
7be68b7c4b Add latexpdf support for Greek as main language (via xelatex use) 
Closes: #6710
 2019-10-01 10:27:43 +02:00
jfbu
a46d4c9bca Improve documentation formatting for Sphinx LaTeX environments 2019-04-12 19:30:31 +02:00
jfbu
f8f4ce8bce Better format documentation of \sphinx... LaTeX macros 2019-04-12 19:21:34 +02:00
jfbu
7e851510eb Fix duplicate reference (my wrong, refs: #5919) 2019-01-13 10:52:42 +01:00
jfbu
ad8205bb0b [DOC] Move description of latex_elements to latex.rst 2019-01-10 16:48:03 +01:00
jfbu
d4d1a4ba84 Merge branch 'master' into latex_tableofcontentshook 2018-12-23 11:31:10 +01:00
jfbu
8e14532b08 LaTeX: move some hard-coded re-definitions to user hook for TOC 2018-12-22 17:33:03 +01:00
jfbu
1920d1d950 LaTeX: `\sphinxmaketitle and optional \sphinxbackoftitlepage` 
Closes: #5849
 2018-12-21 21:38:27 +01:00
Matthias Geier
4af446349c DOC: Fix some minor mistakes in "LaTeX customization" 2018-12-11 18:20:28 +01:00
Matthias Geier
0095449314 DOC: Fix some minor mistakes in "LaTeX customization" 2018-12-11 14:06:59 +01:00
Takeshi KOMIYA
8bc136a9cb Use \sphinxcite instead of \cite 2018-05-03 20:58:30 +09:00
Takeshi KOMIYA
b35198d847 Deprecate highlightlang directive 
highlightlang directive is not documented, and marked as old in v0.2.
 2018-04-15 00:33:02 +09:00
Takeshi KOMIYA
b2bd9f75a6 Merge branch '1.7' 2018-04-09 01:46:00 +09:00
jfbu
e81f80880a Slight rework of latex doc 2018-04-02 19:47:57 +02:00
jfbu
8c55793902 Let LaTeX with XeTeX/LuaTeX not use small typeface in code-blocks 
closes: #4791
 2018-03-28 23:17:34 +02:00
jfbu
4ca7bfc601 Merge branch 'stable' 2017-12-12 11:00:52 +01:00
jfbu
faadbef757 Expose some sphinx.sty LaTeX internals for customizability (refs: #4285) 2017-12-12 10:57:49 +01:00
jfbu
43e6f1aa96 Fix VerbatimHighlightColor key declared non-sphinx-prefixed colour name 2017-12-11 23:09:19 +01:00
jfbu
ad4481eb15 Merge branch 'stable' 2017-12-11 22:54:34 +01:00
jfbu
70f8d4ddfc Support `:emphasize-lines:` in PDF output (closes #1238) 2017-12-10 12:37:36 +01:00
Takeshi KOMIYA
7e7b389eed Merge branch 'stable' 2017-10-23 12:23:58 +09:00
jfbu
6b4a0123fa Fix the fix of #4090 (sorry) 2017-10-22 13:28:46 +02:00
jfbu
5e86c1c934 Fix #4090: extra LaTeX macros via `latex_additional_files` 2017-10-22 13:24:03 +02:00
jfbu
90e3425ed7 Fix #4149: Documentation: Help choosing latex_engine 2017-10-22 11:45:28 +02:00
jfbu
634d76faf1 latex: add option to put literal block captions before or after 
According to ``literalblockcappos`` setting in ``'sphinxsetup'``, (t)op
or (b)ottom, the caption will be typeset before or after the literal
block. If typeset above, its distance to frame is now identical to the
setting used for captions of tables (one half of the baseline).

Further keys ``verbatimcontinuedalign`` and ``verbatimcontinuesalign``
allow to horizontally align the continuation hints relative to the
literal block contents: either (l)eft, (c)enter, or (r)ight.
 2017-06-17 10:40:12 +02:00
jfbu
3d5e0c5d7c Merge branch 'stable' 2017-06-17 10:37:30 +02:00
jfbu
c2277ae61c latex: hint that code-blocks continue on next page (closes #3764) 2017-06-14 09:49:39 +02:00
Takeshi KOMIYA
f6d0b07704 Merge branch 'stable' 2017-06-13 00:32:39 +09:00
jfbu
db8ff5fb75 Fix markup typo and missing bit in docs 2017-06-05 19:43:09 +02:00
jfbu
8b35c36cfe Shorten a definition list in latex docs 2017-06-05 16:55:37 +02:00
jfbu
5e2d4ca77b Merge branch 'stable' 2017-06-05 15:40:18 +02:00
jfbu
bd8c7e1410 Make the latex docs more concise 2017-06-05 15:34:23 +02:00
jfbu
d4f37925c0 Merge branch 'stable' 2017-06-03 17:36:19 +02:00
Sanjeev Gupta
a259df7dea Proof read and polish english. Some typos. 2017-06-02 00:22:33 +08:00
Takeshi KOMIYA
78a20617b5 Merge branch '1.6-release' 2017-05-13 15:42:28 +09:00
jfbu
773659c41a Mention latex table templates in docs 2017-05-11 22:50:58 +02:00
jfbu
f7876f6b74 Update latex docs 2017-05-07 11:12:18 +02:00
jfbu
a700f4631f Merge branch '1.6-release' 2017-05-07 11:11:02 +02:00
jfbu
38e6dfca34 Update latex docs 2017-05-07 11:10:41 +02:00
jfbu
f547e59a7a Merge branch '1.6-release' 2017-05-05 13:34:47 +02:00
jfbu
79412051d2 Merge branch 'stable' into 1.6-release 2017-05-05 13:33:50 +02:00
jfbu
321a5e7a5e Fix #3702: abstract LaTeX styling of figure legends into sphinxlegend 2017-05-04 09:59:29 +02:00
Takeshi KOMIYA
c7d90ab18c Update doc 2017-04-29 15:15:22 +09:00
Takeshi KOMIYA
361a34257b Remove deprecated feature: latex_keep_old_macro_names 2017-04-27 21:49:19 +09:00
Takeshi KOMIYA
aa6dfb8b41 Merge branch 'stable' 2017-03-18 18:25:50 +09:00
jfbu
39bce2f90a Remove documentation of `\sphinxquotedblleft` from next minor release 
Indeed, the macros will perhaps be removed already at 1.6, (PR #3562),
hence it is better not to document them at 1.5.4.
 2017-03-16 23:01:12 +01:00
jfbu
bc0682af0e Merge branch 'stable' 
Conflicts resolved:
	sphinx/domains/cpp.py
	sphinx/domains/python.py
	sphinx/texinputs/sphinx.sty
	sphinx/util/docfields.py
	sphinx/writers/latex.py
	tests/test_build_latex.py

Also updated:
    sphinx/domains/__init__.py
 2017-03-12 13:01:47 +01:00
jfbu
990f51d680 Update latex docs 2017-03-10 08:42:37 +01:00
jfbu
c28e1da763 Update (again) latex docs after PR##3429 2017-03-01 22:26:49 +01:00
jfbu
5b5398768c Make `'extraclassoptions' key of latex_elements` public 2017-02-28 12:43:36 +01:00
Mike Fiedler
a0d39222a7 Update latex.rst 
typo & extra word removal

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
 2017-02-26 09:00:34 +01:00
Mike Fiedler
b8dd3176b8
Update latex.rst 
typo & extra word removal

Signed-off-by: Mike Fiedler <miketheman@gmail.com>
 2017-02-25 20:17:37 -05:00
jfbu
64475a8d7d shorten and link latex docs 2017-02-06 14:24:19 +01:00