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

448 Commits

Author SHA1 Message Date
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
Takeshi KOMIYA
eaf495c3c4 A happy new year! 2020-01-01 14:27:43 +09:00
Takeshi KOMIYA
6d6fe9da0d Add IndexDomain 2019-12-22 17:20:35 +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
0dc456fee1 refactor test: check_xpath() 2019-12-14 22:50:55 +09:00
Takeshi KOMIYA
871e0b58a8 Remove meaningless spaces 2019-12-14 22:26:17 +09:00
Yves Chevallier
06648a3157
Fix annotations 2019-08-08 09:03:29 +02:00
Takeshi KOMIYA
efc0c19142
Merge pull request #6449 from tk0miya/6444_non_existing_urls 
Fix #6444: test: replace example.com by existing page
 2019-06-19 11:19:23 +09:00
Takeshi KOMIYA
d8208d406a Close #1464: html: warn html_static_path is inside outdir 2019-06-18 01:21:08 +09:00
Takeshi KOMIYA
9b2c1c679a Fix #6444: test: replace example.com by existing page 2019-06-05 23:42:24 +09:00
Dmitry Shachnev
9df6e40145 Test that downloads with the same filename are still handled correctly 2019-06-03 20:00:14 +03:00
Dmitry Shachnev
6fc8873087 Make generated download links reproducible 
Without this change the hexdigest generated in DownloadFiles.add_file()
depends on source_dir, while just the path fragment relative to it is
sufficient.
 2019-06-03 19:37:21 +03:00
Omer Katz
e08e7b05d3 Add a label to search input for accessability purposes. 2019-05-12 17:09:18 +09:00
Takeshi KOMIYA
107c20a11f Fix #4550: html: Centering tables by default using CSS 2019-05-06 20:19:53 +09:00
Takeshi KOMIYA
57ecc5733e Fix AssertionError is raised for custom citation_reference node (refs: #6147) 
AssertionError is raised when custom ``citation_reference`` node
having classes attribute refers missing citation (refs: #6147)
 2019-03-09 15:46:03 +09:00
Takeshi KOMIYA
524ac7ff0a Fix #6096: html: Anchor links are not added to figures 2019-02-24 19:29:12 +09:00
Takeshi KOMIYA
a3cdd465ec HTML builder outputs HTML5 by default 2019-02-11 17:46:56 +09:00
Takeshi KOMIYA
25027945f5 Close #4550: All tables and figures without `align` option are displayed to center 2019-02-08 01:39:41 +09:00
Takeshi KOMIYA
3fbb599d23
Merge pull request #5985 from tk0miya/refactor_test_build_html 
refactor: test_build_html.py
 2019-02-04 01:59:21 +09:00
Takeshi KOMIYA
c70dfcd390 Merge branch '1.8' 2019-02-03 19:53:12 +09:00
Takeshi KOMIYA
97782c8ba1 Separate testcase for html_style to single case from root 2019-02-03 19:16:04 +09:00
Takeshi KOMIYA
353e992b37 refactor: test_build_html.py 2019-01-26 17:06:47 +09:00
Takeshi KOMIYA
20bf74c637 Separate jsmath to sphinxcontrib package 2019-01-13 14:07:12 +09:00
Takeshi KOMIYA
c4c878303f encoding keyword for path.text() and path.write_text() is no longer needed 2019-01-03 10:58:07 +09:00
Takeshi KOMIYA
76e9f57c2e Merge branch '1.8' 2019-01-02 16:16:25 +09:00
Takeshi KOMIYA
1b1ebd2c75 A happy new year! 2019-01-02 16:00:30 +09:00
Jon Dufresne
bade33c7e4 Remove unnecessary encoding cookie from Python source files 
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:

https://docs.python.org/3/howto/unicode.html#the-string-type

> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...

Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
 2018-12-16 12:22:12 -08:00
Takeshi KOMIYA
c6bd84a614 refactor: Remove u-prefix from strings 2018-12-16 21:28:51 +09:00
Takeshi KOMIYA
973c3ffa25
Merge branch 'master' into change_master_doc_to_index 2018-09-29 21:12:40 +09:00
Takeshi KOMIYA
3a2418a827 refactoring: Drop PY2 and PY3 flags 2018-09-22 21:27:59 +09:00
Takeshi KOMIYA
abcb5bd5ec The default setting for master_doc is changed to 'index' 2018-09-04 01:14:16 +09:00
Takeshi KOMIYA
34cc1b5c95 Fix #2720, #4034: Incorrect links with `:download:`, duplicate names, and parallel builds 2018-09-03 01:01:55 +09:00
Takeshi KOMIYA
219f024595 Add testcase for pygments 2018-09-02 16:17:02 +09:00
Takeshi KOMIYA
aee5fd04d4 Fix #5348: download reference to remote file is not displayed 2018-08-26 22:25:35 +09:00
Takeshi KOMIYA
dd65d00f29 Implement math_renderer framework 2018-07-28 18:20:11 +09:00
Takeshi KOMIYA
b84240d871
Merge pull request #5108 from tk0miya/alabaster-0.711 
Alabaster 0.711
 2018-06-19 23:35:17 +09:00
Takeshi KOMIYA
285ae7e881 Fix #5066: html: "relations" sidebar is not shown by default 2018-06-16 00:51:21 +09:00
Takeshi KOMIYA
fc7817b854
Merge pull request #5034 from tk0miya/add_html_js_files 
Add :confval:`html_js_files`
 2018-06-09 11:51:11 +09:00
Takeshi KOMIYA
9fc2657d7e Add :confval:html_js_files 2018-06-09 02:38:36 +09:00
Takeshi KOMIYA
e30b10a57d html: Output `canonical_url metadata if :confval:html_baseurl` set 2018-06-06 21:18:17 +09:00
Takeshi KOMIYA
d62a274709 Fix #4983: productionlist directive generates invalid IDs for the tokens 2018-05-22 11:17:50 +09:00
Takeshi KOMIYA
cbf4ee24f9 Fix #4811: The files under html_static_path are excluded from source 2018-05-03 11:07:14 +09:00
Takeshi KOMIYA
5efecd2150 Add :confval:html_css_files 2018-04-06 13:11:24 +09:00
Takeshi KOMIYA
2c7d08ee47 Merge branch '1.7' 2018-03-19 23:46:15 +09:00
Takeshi KOMIYA
39835bf885 Fix #4720: message when an image is mismatched for builder is not clear 2018-03-18 01:35:42 +09:00
Takeshi KOMIYA
4cebc4399c Merge commit '6694981dd6939ab876b27d4e20a8128561c307ac' 2018-03-15 02:02:21 +09:00
Takeshi KOMIYA
88abc67bf8 Merge branch '1.7' into relax-numref-on-sections 2018-03-08 01:11:12 +09:00
Takeshi KOMIYA
31db987d68 Update testcases 2018-03-08 01:11:07 +09:00
Takeshi KOMIYA
938ba386ed Merge branch '1.7' 2018-02-20 00:02:57 +09:00
Takeshi KOMIYA
f7027049b1 Fix flake8 violations 2018-02-19 23:20:56 +09:00
Takeshi KOMIYA
a9f370bc12 test: Remove function based directives 2018-02-08 13:50:25 +09:00
Takeshi KOMIYA
91873f09b8 Merge branch 'stable' into 1.7-release 2018-01-21 16:06:14 +09:00
Takeshi KOMIYA
896ab3a2f5 Fix #4434: pure numbers as link targets produce warning 2018-01-20 19:43:43 +09:00
Takeshi KOMIYA
4d040abafb Fix #4079: Add notranslate class to let Google Translate know they are not translatable 2018-01-13 20:25:49 +09:00
Antoine Beaupré
90f7c7ef3f
add link to manpages in HTML builder 
It is useful to have the HTML documentation builder actually link to
real rendered versions of HTML manpages in its output. That way people
can click on manpages to get the full documentation. There are a few
services offering this online, so we do not explicitly enable one by
default, but the Debian manpages repository has a lot of the manpages
pre-rendered, so it is used as an example in the documentation.

The parsing work is done by a transformer class that parses manpage
objects and extract name/section elements. Those then can be used by
writers to cross-reference to actual sites. An implementation is done
in the two HTML writers, but could also apply to ePUB/PDF writers as
well in the future.

This is not enabled by default: the `manpages_url` configuration item
needs to be enabled to point to the chosen site. The `page`, `section`
and `path` parameters are expanded through Python string formatting in
the URL on output.

Unit tests are fairly limited, but should cover most common use-cases.
 2018-01-11 13:20:34 -05:00
Takeshi KOMIYA
f1f6ca8cc9 Merge branch 'happy_new_year' into master 2018-01-01 01:09:17 +09:00
Takeshi KOMIYA
2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00
Takeshi KOMIYA
a9efb2517a Fix flake8 violations 2017-12-23 21:21:21 +09:00
Takeshi KOMIYA
ec240614d9 test_autodoc: Separate testdata (python objects) and testcases 2017-12-21 12:12:13 +09:00
Takeshi KOMIYA
5bc5b8f013 Merge branch 'stable' 2017-12-16 00:53:55 +09:00
Takeshi KOMIYA
e3bbffc36e test: Add test_html_copy_source 2017-12-15 02:35:32 +09:00
Takeshi KOMIYA
a3f04c3397 Refactor test_build_html: Use basic project instead roots 2017-12-15 02:35:32 +09:00
Takeshi KOMIYA
a5b64c98af diet test-root: Remove html_static_path and html_extra_path (duplicated with test-html_assets) 2017-12-15 02:35:32 +09:00
Takeshi KOMIYA
a8ab1f164b diet test-root: Move testtheme to test-theming 2017-12-15 02:35:32 +09:00
David Lechner
831f89a687 Closes #3160: Use <kbd> tag for :kbd: role in html writers 2017-10-30 10:23:55 -05:00
Takeshi KOMIYA
b78f3090a0 HTML themes can set up default sidebars through `theme.conf` 2017-10-22 15:14:02 +09:00
Andy Neebel
db8663db06 Fix the warnings, need to handle the repr escaping 2017-06-14 13:29:49 -05:00
Andy Neebel
f68c108f10 Mark tests as xfail/skip to allow successful run 2017-06-14 13:27:31 -05:00
Takeshi KOMIYA
2f61be8bb7 Fix Emit wrong warnings if citation label includes hyphens (refs: #3558) 2017-06-04 13:55:14 +09:00
shimizukawa
d497d74370 refs #3458: add sphinx.testing that are moved from /tests directory. 2017-05-14 20:47:15 +09:00
Takeshi KOMIYA
56d3458584 Fix flake8 violations 2017-05-09 21:57:36 +09:00
Dmitry Shachnev
f99f5b23ee Backport fixes for French quotes from docutils 2017-04-25 14:17:31 +03:00
Dmitry Shachnev
1f9e251943 Add tests for English, Russian and French smart quotes 2017-04-25 14:17:29 +03:00
Takeshi KOMIYA
241c0db7bc Merge branch 'master' into support_remote_images 2017-04-22 09:45:05 +09:00
Jakub Wilk
79a841e98c Remove misplaced flags from re.sub() calls 
The 4th argument of re.sub() is maximum number of substitutions,
not flags.

Moreover, re.MULTILINE affects only semantics of ^ and $,
so it wouldn't have any effect on this regular expression.
 2017-04-20 00:04:08 +02:00
Takeshi KOMIYA
a5d77a8f06 Drop warning for nonlocal image URI 2017-04-19 01:40:17 +09:00
Takeshi KOMIYA
3c46c2f5ac Add ImageDownloader transform to support remote images on some builders 2017-04-19 01:40:17 +09:00
Jellby
e59a8028d7 Rewrite and simplify stylesheet handling 
Thanks to tk0miya's comment, I learnt one can add stuff to template
blocks, that allows a much simpler stylesheet configuration, considering
that changes at the template level will be more... well, low-level.
Hopefully this is now acceptable.
 2017-04-15 17:07:33 +02:00
Jellby
1cfed262d2 Merge remote-tracking branch 'upstream/master' 
Conflicts:
	tests/test_build_html.py
 2017-04-15 15:54:06 +02:00
Takeshi KOMIYA
939f01eae3 Fix #3594: LaTeX: single raw directive has been considereed as block level element 2017-04-08 11:54:01 +09:00
Takeshi KOMIYA
8f9dd64992 Merge branch 'stable' 2017-03-26 11:52:15 +09:00
Takeshi KOMIYA
c57e47e042 Year++ 2017-03-26 11:49:34 +09:00
Travis A. Everett
4c67c110f6 Also change depart_admonition calls for html5 builder 2017-03-04 20:32:46 -06:00
Travis A. Everett
cabfcbd70d Fix #3506: consistently pass node to depart_admonition in HTML writer 2017-03-04 13:40:05 -06:00
Jellby
68cf06a2ce Update version (there's still hope) 2017-03-04 12:14:54 +01:00
Jellby
3ce6168958 Merge remote-tracking branch 'upstream/master' 
Conflicts:
	tests/test_build_html.py
 2017-03-04 12:03:15 +01:00
Takeshi KOMIYA
432ec25d9c Fix for py3 2017-03-04 01:03:29 +09:00
Takeshi KOMIYA
ffb627db89 Merge branch 'master' into refactor_inventory 2017-03-04 00:13:39 +09:00
Takeshi KOMIYA
7cb655d7cd Update testcase 2017-03-04 00:02:38 +09:00
Takeshi KOMIYA
c1a70397e1 Add InventoryFile.dump() 2017-03-02 23:48:05 +09:00
Yoshiki Shibukawa
0ef9ac54f1 Add experimental HTML5 writer 2017-03-02 09:56:50 +09:00
Takeshi KOMIYA
0b1178bff7 Merge branch 'stable' 2017-03-01 15:04:28 +09:00
Yoshiki Shibukawa
3502831214 replace internal copy of ElementTree with standard library's ElementTree 2017-03-01 12:01:40 +09:00
Takeshi KOMIYA
496ff70f4a Merge branch 'stable' 2017-02-26 16:01:22 +09:00
Yoshiki Shibukawa
1cce97ad5c Fix &nbsp is appeared in EPUB docs #3450 again 2017-02-26 00:29:25 +09:00
jfbu
99315fa8e0 update root footnote test 2017-02-18 16:26:00 +01:00
Takeshi KOMIYA
e1da72b59c Reduce DeprecationWarnings for regexp 2017-02-17 02:01:04 +09:00
Takeshi KOMIYA
c62a0ad765 Merge branch 'stable' 2017-02-15 01:42:20 +09:00
Takeshi KOMIYA
b9bba672ed Fix #3366: option directive does not allow punctuations 2017-02-15 01:42:08 +09:00
Takeshi KOMIYA
d33cf04979 Merge branch 'stable' 2017-01-29 18:05:17 +09:00
Takeshi KOMIYA
cf2061dfad Fix flake8 violations 2017-01-26 01:13:17 +09:00
Takeshi KOMIYA
8cbe1efe8d Merge branch 'stable' 2017-01-10 01:04:21 +09:00
shimizukawa
b5530629a9 pytest: update by reviewing 
* remove 'specific_srcdir' feature
* simplify 'shared_result' feature
* rename 'AppWrapper' into 'SphinxTestAppWrapperForSkipBuilding'
 2017-01-09 17:41:47 +09:00
shimizukawa
561abdd164 pytest optimizatoin: 
- remote using deprecated decorators
- remove gen_with_app
- remove yield testing
- remove pytest warnings
- refactoring
 2017-01-08 15:14:38 +09:00
shimizukawa
4c22cd10ca Merge branch 'stable' 2017-01-07 02:14:29 +09:00
shimizukawa
baaef9146d pytest: remove deprecated with_app decorator functions 2017-01-06 01:14:47 +09:00
shimizukawa
5b7d237db3 pytest migration 2017-01-04 00:59:30 +09:00