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

428 Commits

Author SHA1 Message Date
Adam Turner
920828fe35 Run the `pyupgrade` tool 2022-10-17 22:39:09 +01:00
Adam Turner
592b46c431
Revert `html_codeblock_linenos_style` removal (#10922) 2022-10-16 16:50:53 +01:00
Adam Turner
e70a0fac6d Merge branch '5.x' 
# Conflicts:
#	.github/workflows/main.yml
#	CHANGES
#	sphinx/__init__.py
#	sphinx/domains/c.py
 2022-10-16 11:24:18 +01:00
Eric Wieser
fa6d42597f
URI-escape image filenames (#10268) 
Without this change, local images with `#` in their name result in incorrect URLs

There is already a similar call to `urllib.parse.quote` for file downloads, suggesting this is a sensible approach.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Takeshi KOMIYA <i.tkomiya@gmail.com>
 2022-10-13 17:37:07 +01:00
Martin Liška
e008e16200
Revert "Fix detection for out of date files (#9360)" (#10908) 
This reverts commit b1390c4191.

The change is reverted because some builders don't have
fine-grained support for outdated docs:
https://github.com/sphinx-doc/sphinx/issues/10903#issuecomment-1273199352
 2022-10-13 13:16:17 +01:00
Martin Liška
b1390c4191
Fix detection for out of date files (#9360) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-05 14:44:41 +01:00
Martin Liška
0a91adb64d
Extend cross referencing options with values (#10883) 
This change means that text following `=`, `[=`, or ` ` is ignored when
searching for a corresponding option directive to an option cross reference
role. These are commonly used options, for example `--profile=path`, 
`--profile[=path]` or `--profile path`.

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-10-02 15:50:53 +01:00
Adam Turner
63dea6172a Merge branch '5.x' 
# Conflicts:
#	sphinx/locale/__init__.py
 2022-09-30 16:15:24 +01:00
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
Adam Turner
bb62d2a2ee Increase minimum Docutils to 0.18 2022-09-27 18:31:47 +01:00
Adam Turner
080517ce55 Increase minimum Docutils to 0.17 2022-09-27 18:31:47 +01:00
Adam Turner
f01d50d695 Merge branch '5.x' 
# Conflicts:
#	CHANGES
#	doc/conf.py
#	sphinx/__init__.py
#	sphinx/builders/html/__init__.py
#	sphinx/domains/python.py
#	tests/test_build_html.py
 2022-09-25 21:36:30 +01: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
Adam Turner
14c9b40f15 Merge branch '5.x' 
# Conflicts:
#	setup.py
#	sphinx/application.py
#	sphinx/environment/__init__.py
#	sphinx/ext/autodoc/directive.py
#	tests/test_build_html.py
 2022-09-09 09:58:24 +01:00
Adam Turner
f35d2a6cc7
Remove Pygments compatability code (#10812) 2022-09-09 05:08:48 +01:00
Adam Turner
a4d41aa889 Merge branch '5.x' 2022-07-17 21:53:12 +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
danieleades
25d379fb53
Lint with flake8-bugbear (#10602) 
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
 2022-07-12 22:55:57 +01:00
Jean-François B
80198e82aa Merge branch '5.x' into master 
Resolved merge conflicts:
    sphinx/ext/extlinks.py
    sphinx/ext/napoleon/docstring.py
    (and removed from the latter a now unused import for flake8 F401
    compliance)
 2022-06-30 15:00:16 +02:00
Martin Liška
ea46202565
Fix parsing of options with enabled option_emphasise_placeholders (#10565) 2022-06-19 22:51:48 +01:00
marxin
3a269ee590 Fix usage of enable_search_shortcuts theme config value. 
The option value is not properly propagated to Java script.
 2022-06-17 21:21:27 +02:00
Adam Turner
7e38d2dad8 Merge branch '5.x' 
# Conflicts:
#	.github/workflows/builddoc.yml
#	.github/workflows/lint.yml
#	sphinx/registry.py
 2022-06-16 21:46:54 +01:00
Ezio Melotti
1a1491b8a7
Show the repr of the value in some warnings (#10439) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2022-06-16 21:07:25 +01:00
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