IntenseWebs/sphinx
3
0 Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-11-02 20:30:30 -06:00
Code Issues Packages Projects Releases Wiki Activity
14,914 Commits 4 Branches 238 Tags
b9da9237bc04e6d8da46045b18780d853c7581ef
Commit Graph
2734 Commits
Author SHA1 Message Date
Takeshi KOMIYA 6d6fe9da0d Add IndexDomain 2019-12-22 17:20:35 +09:00
Takeshi KOMIYA e83bb29789 Merge pull request #6873 from tk0miya/5923_autodoc_inherited_members_can_ignore_specific_superclass 
Close #5923: autodoc: allow not to document inherited members of specific super class
 2019-12-22 16:30:56 +09:00
Takeshi KOMIYA a209002b81 doc: Add examples for :inherited-members: 2019-12-22 16:05:45 +09:00
Takeshi KOMIYA d47f38e22d Merge branch '2.0' 2019-12-21 12:21:49 +09:00
Takeshi KOMIYA 00c30679cf Deprecate sphinx.io.FiletypeNotFoundError and get_filetype() 2019-12-16 01:45:02 +09:00
Takeshi KOMIYA 9b958f9525 Merge pull request #6925 from jdufresne/text-js 
Remove redundant type="text/javascript" from <script> elements
 2019-12-16 01:29:46 +09:00
Jon Dufresne e6915baae8 Remove redundant type="text/javascript" from <script> elements 
In HTML5, <script> elements default to MIME type text/javascript. The
HTML5 living standard and MDN recommend against including the attribute.

From https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-type

> The HTML5 specification urges authors to omit the attribute rather
> than provide a redundant MIME type.

From https://html.spec.whatwg.org/#the-script-element

> Authors should omit the type attribute instead of redundantly setting
> it.
 2019-12-15 07:52:40 -08:00
Takeshi KOMIYA 29687a29f1 Close #6446: Add sphinx.ext.durations to inspect durations of build 2019-12-16 00:47:23 +09:00
Takeshi KOMIYA 712c20a3d9 Merge branch '2.0' 2019-12-16 00:05:35 +09:00
jfbu 30b26dd6a1 LaTeX: avoid quotes and TeX ligature replacements in PDF output 
Refs: #6890

The comma character is not TeX-escaped because it is frequent in general
text and escaping it would make the LaTeX output larger for only dealing
with the problem of the LaTeX-ligature of ,, into a single character.
And one there is problem with the commas in options to Verbatim from
PygmentsBridge.

The hyphen character is escaped (not in ids and URIs!) to
\sphinxhyphen{} for both Unicode and non-Unicode engines. This is needed
to work around hyperref transforming -- and --- from section titles into
EN DASH resp. EM DASH in PDF bookmarks.

https://github.com/latex3/hyperref/issues/112

Note to expert LaTeX users: if Sphinx latex user with xelatex has

- turned off Smart Quotes for some reason,

- but does want TeX ligatures and thus overrode Sphinx
latex_elements['fontenc'] default (since #6888) to this effect,

then this should be added to LaTeX preamble:

    \def\sphinxhyphen#1{-}% (\protected is now not needed)
    \let\sphinxhyphenforbookmarks\sphinxhyphen
 2019-12-15 14:19:50 +01:00
Damien Ayers 1a54a7229c Fix documentation typo 
(cherry picked from commit 937c684960)
 2019-12-13 23:27:04 +01:00
Damien Ayers 937c684960 Fix documentation typo 2019-12-13 12:33:02 +11:00
jfbu 2199a127e8 Typo (refs #6491) 2019-12-09 22:57:45 +01:00
Olle Hynén Ulfsjöö e35507ffd0 Add sphinxcontrib-beamer to list of extensions. 
Change-Id: I943e42508cc8ca4e20c65803c1bca225195ddd0e
 2019-12-09 11:06:23 +01:00
Takeshi KOMIYA 7ec567b6d0 Merge branch '2.0' 2019-12-09 00:13:42 +09:00
Takeshi KOMIYA 9e40f2a603 doc: rewrite options for code-block by directive:option directive 2019-12-08 21:33:06 +09:00
Takeshi KOMIYA d82e0bb5a5 doc: rewrite options for highlight by directive:option directive 2019-12-08 21:33:06 +09:00
jfbu 73a2228c87 Update 'fontenc' latex_elements key documentation 2019-12-07 12:27:21 +01:00
Takeshi KOMIYA fb9adbf0be Merge pull request #6870 from stsewd/update-docs-intersphinx-with-basic-auth 
Update docs about intersphinx and basic auth support
 2019-12-03 01:42:37 +09:00
Takeshi KOMIYA 7292ab7eef Merge branch '2.2.2' into 2.0 2019-12-03 01:19:02 +09:00
Santos Gallegos 46c68302be Be more specific about the type of login 2019-12-02 11:07:17 -05:00
Takeshi KOMIYA 7c79a6b8d1 Close #5923: autodoc: allow not to document inherited members of specific super class 2019-12-01 12:51:28 +09:00
Takeshi KOMIYA 15c266c445 Merge branch '2.0' 2019-11-30 21:52:42 +09:00
Takeshi KOMIYA 82a6048f12 Fix typo 2019-11-28 23:31:08 +09:00
Santos Gallegos f7c1e9190a Linter 2019-11-27 15:38:26 -05:00
Santos Gallegos a72d8f6808 Update docs about intersphinx and basic auth support 
This was added in #2089 but the docs don't mention it.
 2019-11-27 15:23:52 -05:00
Takeshi KOMIYA 1cc1481771 Merge pull request #6866 from tk0miya/napoleon_doc_fix 
doc: URL of numpydoc has changed
 2019-11-27 01:25:33 +09:00
Takeshi KOMIYA 82b2b1752a doc: URL of numpydoc has changed 2019-11-27 00:12:32 +09:00
Takeshi KOMIYA 9bd64e4e2a Merge pull request #6862 from tk0miya/6854_update_supported_languages_list 
Update supported languages (refs: #6854)
 2019-11-27 00:04:22 +09:00
jfbu dc53404d48 Fix markup issue in our docs 2019-11-26 14:22:17 +01:00
jfbu d398959230 Fix typo in docs 2019-11-26 14:11:40 +01:00
Takeshi KOMIYA 995dfa4e73 Merge pull request #6816 from jonashaag/linkcheck-auth 
Add linkcheck_auth option
 2019-11-26 01:29:30 +09:00
Takeshi KOMIYA 1faf14d411 Update supported languages (refs: #6854) 2019-11-26 01:22:14 +09:00
Takeshi KOMIYA 6de29cdb84 Merge pull request #6854 from jfbu/doc_mention_Greek_as_supported_language 
DOC: add Greek to list of supported languages
 2019-11-26 00:56:34 +09:00
Jonas Haag df2f80c755 Add linkcheck_auth option 2019-11-25 09:53:45 +01:00
jfbu 70f087990b DOC: add Greek to list of supported languages 2019-11-22 19:15:59 +01:00
Takeshi KOMIYA c65243325c Merge branch '2.0' into 6798_autosummary_emits_skip_member_event 2019-11-21 00:45:57 +09:00
Takeshi KOMIYA cba9ff9ce2 Merge pull request #6841 from tk0miya/4186_uplatex 
Fix #4186: LaTeX: Support upLaTeX as a new latex_engine (experimental)
 2019-11-21 00:42:21 +09:00
Sylvestre Ledru 3aef93c4a3 Fix the URL to https://pygments.org/docs/lexers.html 2019-11-20 14:49:15 +01:00
Takeshi KOMIYA c6f0eb215a Fix #4186: LaTeX: Support upLaTeX as a new latex_engine (experimental) 2019-11-17 17:37:48 +09:00
Takeshi KOMIYA 6644830941 Merge branch '2.0' 2019-11-17 14:24:04 +09:00
Joe 1fd7176f89 Fix link to pygments lexer 2019-11-16 18:11:14 -08:00
Takeshi KOMIYA f3469bcc8f Make escape() and hlescape() as public APIs of texescape 2019-11-16 19:42:06 +09:00
Takeshi KOMIYA 5f559fbb98 Deprecate sphinx.util.texescape.tex_escape_map 2019-11-16 18:34:48 +09:00
Takeshi KOMIYA 66c3dd3adb Close #6798: autosummary: emit `autodoc-skip-member` event on generating stub file 2019-11-16 18:19:31 +09:00
Takeshi KOMIYA 8f554c465d Merge pull request #6802 from tk0miya/6781_gettext_template 
gettext: Use template file to generate message catalog
 2019-11-15 02:33:09 +09:00
Takeshi KOMIYA 399f773d9d gettext: Use template file to generate message catalog 2019-11-08 00:36:57 +09: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 b4cd34c8f4 Merge branch '2.0' into 1331_useragent 2019-11-05 22:58:33 +09:00
Takeshi KOMIYA 4ec563fcff Close #6762: latex: Allow to load additonal LaTeX packages 2019-11-05 22:25:41 +09:00