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,910 Commits 2 Branches 219 Tags 163 MiB
c8f4a03dac
Commit Graph

147 Commits

Author SHA1 Message Date
Adam Turner
c8f4a03dac Fix COM812 2023-02-18 01:58:05 +00:00
John Gardner
28d184c0d6
Add test for multi-word key names (`kbd` role) (#10765) 2022-12-30 00:57:51 +00:00
Adam Turner
bf06d7ef4d
Factor out HTML 4 translator (#11051) 
Move the HTML 4 translator into a private module.
 2022-12-30 00:53:04 +00:00
Adam Turner
080517ce55 Increase minimum Docutils to 0.17 2022-09-27 18:31:47 +01:00
Adam Turner
6ef22d2613
Increase static typing strictness (#10530) 2022-06-16 19:50:01 +01:00
Adam Turner
0447fbe60d Use docutils.__version_info__ directly 2022-04-22 04:21:38 +01:00
Adam Turner
a8827f3329 Catch DeprecationWarning for docutils.frontend.OptionParser 2022-04-22 04:21:38 +01:00
Hugo van Kemenade
658689433e Include trailing / in PEP URL to avoid 301 redirect 2022-03-24 13:31:17 +02:00
Takeshi KOMIYA
168adb0f0e test: Fix test_markup does not use default settings for docutils 2022-03-19 22:58:27 +09:00
Michal Čihař
ef79a2bc70 environment: Update default value for pep_base_url 
This matches docutils change in https://sourceforge.net/p/docutils/code/9045/

Fixes #10253
 2022-03-16 13:57:51 +01:00
Adam Turner
5775912455 Collapse single line docstrings 2022-02-20 03:13:45 +00:00
Adam Turner
6bb7b891a1 Remove copyright and licence fields 2022-02-20 03:06:23 +00:00
Adam Turner
5694e0ce60 Fix module docstring indentation 2022-02-20 00:35:13 +00:00
Adam Turner
4f5a3269a6 Fix module docstring first line 2022-02-20 00:11:08 +00:00
Adam Turner
6b8bccec59 Remove module titles in docstrings 2022-02-19 23:17:29 +00:00
Takeshi KOMIYA
9d29adb76c The latest docutils converts :pep: role to the "https" URL (again) 
docutils-0.19 (unreleased) generates "https" URL from :pep: role.
 2022-02-13 19:22:17 +09:00
Takeshi KOMIYA
083b0b5207 The latest docutils converts :pep: role to the "https" URL 
docutils-0.19 (unreleased) generates "https" URL from :pep: role.
 2022-02-06 23:10:25 +09:00
Takeshi KOMIYA
a0e44a7300 test: Migrate to Node.findall() from Node.traverse() 2022-01-03 01:06:20 +09:00
Takeshi KOMIYA
b84771dcd2 A happy new year! 2022-01-01 18:45:03 +09:00
Matt Ficke
2ed4bed33a Update RFC base url 
The tools.ietf.org subdomain is being wound down and services are moving to
datatracker.ietf.org. Links to RFC documents using the old subdomain are being
redirected to datatracker; this updates the configured `rfc_base_url` to
point to the current subdomain.

Discussion: https://mailarchive.ietf.org/arch/msg/ietf/0n-6EXEmkTp3Uv_vj-5Vnm3o0bo/
 2021-11-16 10:52:02 -05: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
185a2d27fe Fix #8780: long words in narrow columns may not be hyphenated 
This is done by adding '\hskip0pt\relax\n' whenever a paragraph starts.
 2021-01-29 00:24:44 +01:00
Takeshi KOMIYA
949ec8737f Close #1638: html: Add permalink icons to glossary terms 2021-01-24 23:35:37 +09:00
Takeshi KOMIYA
d6f41227d7 Fix #8714: html: kbd role with "Caps Lock" rendered incorrectly 
`:kbd:` role has to support keys in consist of multiple words (ex. caps
lock, num lock, etc.)
 2021-01-22 21:58:19 +09:00
Takeshi KOMIYA
7ecf6b88aa Merge branch '3.4.x' into 3.x 2021-01-01 13:56:19 +09:00
Takeshi KOMIYA
f996859420 A happy new year! 
.. note::

   $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \;
   $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
 2021-01-01 13:40:48 +09:00
Takeshi KOMIYA
2eb8927b89 Fix test: missing compound class for kbd tag 2020-12-31 21:20:38 +09:00
Takeshi KOMIYA
b31b8df9bf
Merge pull request #8620 from tk0miya/8619_compound_kbd 
Close #8619: html: kbd role generates customizable HTML tags for compound keys
 2020-12-31 21:11:42 +09:00
Takeshi KOMIYA
6a53c53d53 Fix #8618: html: incorrect HTML for single compound-kdb separators 2020-12-30 21:12:00 +09:00
Takeshi KOMIYA
8e5f4e5616 Close #8619: html: kbd role generates customizable HTML tags for compound keys 2020-12-30 20:36:09 +09:00
Takeshi KOMIYA
21a3bd4127 refactor: Fix flake8 violations under tests/ directory 2020-11-15 17:15:40 +09:00
François Freitag
0949735210
Sort imports with isort 
Keep imports alphabetically sorted and their order homogeneous across
Python source files.

The isort project has more feature and is more active than the
flake8-import-order plugin.

Most issues caught were simply import ordering from the same module.
Where imports were purposefully placed out of order, tag with
isort:skip.
 2020-11-11 13:19:05 +01:00
Takeshi KOMIYA
71b653719d Fix #7610: incorrectly renders consecutive backslashes 2020-05-07 00:54:36 +09:00
Takeshi KOMIYA
a5036270c8
Merge pull request #7605 from tk0miya/refactor_tests 
Refactor tests
 2020-05-04 01:27:54 +09:00
Takeshi KOMIYA
f01ea79092 refactor: Pass a theme instance to LaTeXTranslator 2020-05-03 23:56:59 +09:00
Takeshi KOMIYA
a148a8e7cb Close #7530: html: Support nested <kbd> elements 2020-05-02 22:48:57 +09:00
Jesse Tan
7c1b673076 Add LaTeX styling hook for :kbd: role 2020-01-09 16:35:40 +01:00
Takeshi KOMIYA
eaf495c3c4 A happy new year! 2020-01-01 14:27:43 +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
Takeshi KOMIYA
660e746cf8 Fix #6738: latex: literal_block does not support raw unicode characters 2019-11-16 16:47:20 +09:00
Takeshi KOMIYA
9b2c1c679a Fix #6444: test: replace example.com by existing page 2019-06-05 23:42:24 +09:00
Takeshi KOMIYA
90bf81bd37 test: Use get_doctree() to load doctree files 2019-02-17 20:27:48 +09:00
Takeshi KOMIYA
61f1477942 Add testcase for XRefRole class 2019-02-16 21:23:01 +09:00
Takeshi KOMIYA
6748a6de2f Add testcase for download role 2019-02-16 21:23:01 +09:00
Takeshi KOMIYA
3ec032fa39 Replace :file: and :samp: roles by class based implementation 2019-02-16 12:37:46 +09:00
Takeshi KOMIYA
ea4d8ca08d Replace :guilabel: and :menuselection: roles by class based implementation 2019-02-16 02:30:28 +09:00
Takeshi KOMIYA
cb49a6b091 Fix :pep: and :rfc: roles are broken 2019-02-16 01:47:52 +09:00
Takeshi KOMIYA
66228fb60f Fix #5906: LaTeX Builder is not initialized correctly on test_markup 2019-01-08 01:30:25 +09:00
Takeshi KOMIYA
1c34501e85 refactor: Move \figurename to sphinxmessage.sty 2019-01-04 23:06:34 +09:00
Takeshi KOMIYA
7459d8771a Fix HTML: Invalid HTML5 file is generated for glossary (refs: #4611) 
Note: It was caused by a glossary having multiple terms for one
description.
 2019-01-03 18:17:17 +09:00