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
20,276 Commits 2 Branches 219 Tags 163 MiB
f1b2682d58
Commit Graph

454 Commits

Author SHA1 Message Date
Adam Turner
ce31e1c0c7
Remove deprecated items for Sphinx 6.0 (#10471) 2022-06-16 21:05:37 +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
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
Adam Turner
4674cc11c8 .write_text(...) -> .write_text(..., encoding='utf8') 2022-04-27 03:11:08 +01:00
Adam Turner
24e3b7c8c8 .read_text() -> .read_text(encoding='utf8') 2022-04-27 03:04:19 +01:00
Adam Turner
0447fbe60d Use docutils.__version_info__ directly 2022-04-22 04:21:38 +01:00
Takeshi KOMIYA
2db180da70 Merge branch '4.x' 2022-03-27 19:47:11 +09:00
Hugo van Kemenade
658689433e Include trailing / in PEP URL to avoid 301 redirect 2022-03-24 13:31:17 +02:00
Jeremy Maitin-Shepard
099b54cb87 Make code role highlighting consistent with code-block directive 
Fixes https://github.com/sphinx-doc/sphinx/issues/5157

This is factored out of the sphinx-immaterial theme:
1ef121a612/sphinx_immaterial/inlinesyntaxhighlight.py (L1)

See also:
https://github.com/sphinx-doc/sphinx/pull/6916
 2022-03-19 20:37:49 -07:00
Takeshi KOMIYA
aa1bc83c2a Merge branch '4.x' 2022-03-19 22:58:15 +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
f72cd83e4d Merge branch '4.x' 2022-02-19 16:08:05 +09:00
Takeshi KOMIYA
6a0215198f Merge branch '4.x' 2022-01-16 02:26:11 +09:00
Takeshi KOMIYA
48dc4b8a96 test: Follow the new HTML structure of docutils-0.18 
Since docutils-0.18, the HTML structure for citations and footnotes has
been changed.  This modifies our testcase to follow the new HTML structure.
 2022-01-13 02:12:37 +09:00
Daniel Eades
61ff90460d use 'callable' to check if object is callable (B004) 2022-01-10 13:51:35 +00:00
Pradyun Gedam
bc635627d3
Change "Permalink to this {headline -> heading}" 
"heading" is a better word to use in this tooltip, since it better
matches the use case.
 2022-01-02 18:32:30 +05:30
Takeshi KOMIYA
f38bd8e952 Merge branch '4.3.x' into 4.x 2022-01-01 20:02:10 +09:00
Takeshi KOMIYA
b84771dcd2 A happy new year! 2022-01-01 18:45:03 +09:00
Takeshi KOMIYA
b5bf745f68 Close #10013: html: Allow to change the loading method of JavaScript 2021-12-25 23:41:02 +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
Takeshi KOMIYA
ee1cae8c1c Replace distutils.versions.LooseVersion by packaging.version.Version 
Distutils module are now deprecated and will be removed in Python 3.12.
This replaces it by packaging module and reduces the dependency to it.

refs: #9820
 2021-11-07 20:15:07 +09:00
Johannes Aalto
fa3b334ed0 Add test for encoding local file links with special characters 
Add test to make sure Sphinx uses proper URL encoding for
special characters in file names.

Use test_html_download() since it test_html5_output() doesn't
quite seem to have easy pattern to verify the contents of href
attribute.

Issue #3097

Signed-off-by: Johannes Aalto <ext-johannes.aalto@vaisala.com>
 2021-09-24 20:34:09 +03:00
Simon Hausmann
3a50abc5c9 Fix handling of local paths in html_logo/html_favicon directorives in conf.py 
Merge request #9381 broke support for local logos/favicons as it
retained the paths that are passed to the template engine. That's wrong
as the actual path will be in _static/.

This should fix #9438
 2021-07-13 18:03:36 +02:00
Takeshi KOMIYA
f40c2837dc
Merge pull request #9225 from doerwalter/typehint-html 
Add HTML markup to method/function return typehint
 2021-07-11 12:03:40 +09:00
Simon Hausmann
6a4c215cf0 Add unit test for remote logo and fav icon 2021-06-28 13:28:29 +02:00
Walter Doerwald
9aedeee538 Remove configuration option html_signaturereturn_icon. 2021-06-14 14:02:19 +02:00
Walter Doerwald
798adc4f57 Add tests for html_signaturereturn_icon. 2021-05-22 20:15:11 +02:00
Jakob Lykke Andersen
f769dde254 Decl styling, fix html test 2021-04-12 19:07:51 +02:00
Takeshi KOMIYA
8d60b04844 Fix CI: NameError for missing docutils variable in test_build_html 2021-04-04 00:28:08 +09:00
Takeshi KOMIYA
41a377fee5 Merge branch '3.x' 2021-04-04 00:06:45 +09:00
Takeshi KOMIYA
c2ee74f166 test: Update testcase for docutils-0.17 (<figure> and <figcaption>) 
Since v0.17, docutils starts to use <figure> and <figcaption> for figure
and its caption on HTML output.  This modifies the expected value of our
testcases to support it.
 2021-04-03 23:54:19 +09:00
Takeshi KOMIYA
f9ca909ea0 Merge branch '3.x' 2021-02-17 00:16:32 +09:00
jfbu
19ea727f1b Adapt our tests to Pygments 2.8.0 2021-02-14 21:17:17 +01:00
jfbu
fbafb308b8 Merge branch '3.x' into master_with_merged_3.x 2021-02-02 18:01:55 +01:00
Takeshi KOMIYA
af6ed52ca1
Merge branch '3.x' into 8446_escape_spaces_inside_desc_signatures 2021-02-01 01:24:02 +09:00
Takeshi KOMIYA
c9480f9943 Merge branch '3.x' 2021-01-28 00:56:46 +09:00
Takeshi KOMIYA
949ec8737f Close #1638: html: Add permalink icons to glossary terms 2021-01-24 23:35:37 +09:00
Takeshi KOMIYA
502c4ee5fb Merge branch '3.x' 2021-01-24 14:32:13 +09:00
Takeshi KOMIYA
15cbc6dbb0 Close #6550: html: Allow to use HTML permalink texts 
Add new configuration variables: `html_permalinks` and
`html_permalinks_icon`.

This refines the settings around HTML permalinks.

* html_add_permalinks
  * Deprecated.
* html_permalinks
  * Enable or disable permalinks feature.
* html_permalinks_icon
  * Change the icon for permalinks
 2021-01-24 14:17:07 +09:00
Takeshi KOMIYA
30f8640bab Merge branch '3.x' 2021-01-16 21:51:46 +09:00
Takeshi KOMIYA
32ac5f2e57 Close #207: Now highlight_language supports multiple languages 
This changes the structure of `highlight_options` to a dictionary that
maps language names to option dictionary.  It allows to setting pygments
options for multiple languages at once.
 2021-01-11 21:40:09 +09:00
Takeshi KOMIYA
5460ea103b Merge branch '3.x' 2021-01-08 01:23:17 +09:00
Takeshi KOMIYA
5b392e3951 refactor: Move CSS tags in basic/layout.html to `css_files` variable 
To make CSS customizable, all CSS files in basic/layout.html has their
priority: 200.  Therefore, extensions and users can insert their own
custom CSS files before or just after them.

As a side effect, the CSS tags in basic/layout.html are removed.  These
CSS files will be rendered via `css_files` template variable.

refs: #8634, c5f0398010
 2021-01-03 02:41:17 +09:00
Takeshi KOMIYA
a9c7dd7037 Merge branch '3.x' 2021-01-03 00:20:27 +09:00
Takeshi KOMIYA
e9a4ebf70d doc: Add explanation for the priority attribute of html_*_files 2021-01-03 00:16:10 +09:00
Takeshi KOMIYA
c5f0398010 Close #8634: html: Allow to change the order of JS/CSS 
`Sphinx.add_js_file()` and `Sphinx.add_css_file()` take `priority`
argument to change the order of JS/CSS files.
 2021-01-02 02:06:34 +09:00
Takeshi KOMIYA
4b452338f9 Merge branch '3.x' 2021-01-01 13:57: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
2c98e909bf Merge branch '3.x' 2020-12-14 02:02:29 +09:00
Takeshi KOMIYA
478a1567b6 Fix #8360: Update warning message for numref 2020-11-23 01:36:35 +09:00
Takeshi KOMIYA
96fe4c110c Fix #8446: html: consecutive spaces are displayed as single space 
In HTML, consecutive spaces are considered as single space by HTML
browsers.  To represent them as is, we have to escape them on rendering
them into HTML.  This starts to escape the whole of desc_signature node.
 2020-11-22 23:12:04 +09:00
Takeshi KOMIYA
279e547860 Merge branch '3.x' 2020-11-12 02:50:43 +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
c40b4249cd Merge branch '3.x' into master 2020-10-28 02:23:36 +09:00
Takeshi KOMIYA
4f19f400bf refactor: Remove rst_epilog from test-root/conf.py 
I found test-root defines rst_epilog in its conf.py.  It causes
side-effects to many test cases in Sphinx's testing because test-root
is widely used.  This removes the configuration from test-root not to
cause side-effects to our testings.

Note: We already have test cases for rst_epilog in test_util_rst.
 2020-10-06 01:53:29 +09:00
Takeshi KOMIYA
26ea870267 Merge branch '3.x' into master 2020-10-03 13:43:21 +09:00
Robert Cohn
3d81abef9c respond to review comments 2020-10-01 11:12:39 -04:00
Robert Cohn
c08214fe92 add parallel to SphinxTestApp 2020-09-30 20:47:56 -04:00
Takeshi KOMIYA
bec30596a8 Merge branch '3.x' into master 2020-09-13 10:54:21 +09:00
Takeshi KOMIYA
85b24a2e88 Fix our test failed with pygments-2.7.0 
Since pygments-2.7.0, it has changed the style of output HTML.
That makes our test broken.  This fixes it to pass with new pygments.
 2020-09-13 10:42:07 +09:00
Takeshi KOMIYA
327c187284 Merge branch '3.x' 2020-07-24 23:49:45 +09:00
Takeshi KOMIYA
081dcd23c1 test: Remove search link from test-root 
To make EPUB output valid, remove a search link from test-root.
 2020-07-18 16:57:51 +09:00
Takeshi KOMIYA
70d521ad9c Merge branch '3.x' 2020-07-11 21:59:58 +09:00
Takeshi KOMIYA
6dfbc5108e Close #7849: html: Add html_codeblock_linenos_style 2020-07-11 20:59:38 +09:00
Takeshi KOMIYA
44f4b2ad97 Merge tag 'v3.1.0' 2020-07-05 00:10:47 +09:00
Luke Lau
1e7d9269e9 Let option directive support args in the form of foo[=bar] 
This slightly tweaks the regex so that command line flags of the form
foo[=N] are properly split up. This is useful for any programs that can
take `--foo` as a flag on its own as well as with an extra argument
`--foo=12`.
 2020-06-03 16:35:00 +01:00
Takeshi KOMIYA
3c7d35d2a2 Merge branch '3.x' 2020-05-17 19:12:56 +09:00
Lars Hupfeldt
8bbc7b83c0 Rename fips_safe_md5 to md5 2020-05-05 10:12:41 +02:00
Lars Hupfeldt
1b8415a1c1 Introduce fips_safe_md5, see issue #7611 2020-05-05 00:50:51 +02:00
Takeshi KOMIYA
4860b451f2 Merge branch '3.x' 2020-04-06 00:23:29 +09:00
Takeshi KOMIYA
7aa5584a47 Fix #7301: capital characters are not allowed for node_id 2020-03-29 23:55:56 +09:00
Takeshi KOMIYA
90fb44ee43 Merge branch '3.x' 2020-03-23 00:07:51 +09:00
Takeshi KOMIYA
7bbf79c313 Fix #7301: Allow . and _ for node_id 
In development of 3.0, Sphinx starts to obey to the rule of
"Identifier Normalization" of docutils.  This extends it to allow
dots(".") and underscores("_") for node identifier.

It allows Sphinx to generate node identifier from source string as
possible as it is (bacause dots and underscores are usually used in
many programming langauges).

This change will keep not to break hyperlinks as possible.
 2020-03-22 16:39:00 +09:00
Takeshi KOMIYA
c7e590818a Merge branch '3.x' 2020-03-21 17:53:22 +09:00
Jakob Lykke Andersen
0f49e30c51 C, initial rewrite 2020-03-15 19:49:16 +01:00
Takeshi KOMIYA
a0bef9a86d
Merge pull request #7142 from septatrix/html-auxiliary-pygments-style 
Add option for auxiliary pygments styles
 2020-03-15 22:20:44 +09:00
Septatrix
81fe5f8477 Remove html_pygments_dark_style option 2020-03-14 18:46:02 +01:00
Septatrix
6314419bc5 Add tests for pygments_dark_style options 2020-03-14 15:10:25 +01:00
Takeshi KOMIYA
5c0d0438c4
Merge pull request #6990 from tk0miya/function_signature 
py domain: Allow to make a style for arguments of functions and methods
 2020-03-14 17:42:04 +09:00
Takeshi KOMIYA
50cf68e0d4 py domain: Allow to make a style for arguments of functions and methods (refs: #6417) 2020-03-14 16:55:55 +09:00
Takeshi KOMIYA
f4c29949ce c domain: Generate node_id for objects in the right way 2020-03-09 02:00:26 +09:00
Takeshi KOMIYA
3e0618ba3a Deprecate codes for docutils-0.13 or 0.14 2020-03-07 19:36:41 +09:00
Takeshi KOMIYA
729efd28b0 py domain: Generate node_id for objects in the right way 2020-03-07 02:00:50 +09:00
Takeshi KOMIYA
c0535d700e std domain: Generate node_id for productionlists in the right way 2020-03-06 02:10:04 +09:00
Takeshi KOMIYA
fbfaf41e83 std domain: Generate node_id for generic objects in the right way 2020-03-02 01:28:01 +09:00
Takeshi KOMIYA
7216c1945b Stop to use Path.text() 2020-02-23 12:53:31 +09:00
Takeshi KOMIYA
db20d923d1 Merge branch '7144_styling_desc_by_domainname' into 3.x 2020-02-22 18:42:04 +09:00
Takeshi KOMIYA
9db38aadfd Fix #3106: domain: Register hyperlink target for index page automatically 2020-02-22 18:20:12 +09:00
Takeshi KOMIYA
a033d53c24 Close #7032: html_scaled_image_link is disabled for individual image 2020-02-18 01:48:11 +09:00
Takeshi KOMIYA
333596dc10 Close #7144: Add CSS class indicating its domain for each desc node 2020-02-16 22:31:12 +09:00
Takeshi KOMIYA
bdd08b1516 test: encoding="utf-8" is no longer needed on reading text 2020-02-01 12:25:49 +09:00
Takeshi KOMIYA
4dd8b1022f test: Use read_text() and read_bytes() 2020-02-01 11:58:51 +09:00
Jakob Lykke Andersen
9fa23615ec Fixes from review 2020-01-25 17:02:59 +01:00
Jakob Lykke Andersen
c084c3f124 Implement scoping for productionlist 
Fixes sphinx-doc/sphinx#3077
 2020-01-22 22:32:30 +01:00