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,294 Commits 2 Branches 219 Tags
1e30b8cd4d7a0433e59aec0e2d7fd876bf452076
Commit Graph

5731 Commits

Author SHA1 Message Date
Takeshi KOMIYA
777b1fa105 Merge branch '4.x' into 9529_named_footnotes_in_latex 2022-02-11 13:08:26 +09:00
Takeshi KOMIYA
680417a10d Merge pull request #10150 from tk0miya/10146_autodoc_default_options_should_support_no-value 
Close #10146: autodoc: autodoc_default_options does not support `no-value` option
 2022-02-06 15:59:24 +09:00
Takeshi KOMIYA
1546b21f89 Fix #9529: LaTeX: named footnotes are converted to "?" 
Named auto numbered footnote (ex. ``[#named]``) that is referred
multiple times was rendered to a question mark.

This calls `\sphinxstepexplicit` for every footnote node that is
referred multiple times.
 2022-02-06 15:59:01 +09:00
Takeshi KOMIYA
1d68973f20 Merge branch '4.4.x' into 4.x 2022-02-06 15:57:00 +09:00
Adam Turner
3b01fbe2ad Drop JavaScript Frameworks (#10028) 
* Delete jQuery and underscore.js

* Move underscores.js setup to searchtools.js

* Update jQuery.url(en|de)code

* Update jQuery.getQueryParameters

* Firefox bug is no longer present

xref https://bugzilla.mozilla.org/show_bug.cgi?id=645075#c49

* Update jQuery.fn.highlightText

* Use enum instead of magic number

* Update test descriptions to remove obsolete jQuery reference

* Update Documentation.getCurrentURL

* Revert accidental fix of Documentation.getCurrentURL

* Update Documentation.initOnKeyListeners

* Update Documentation.hideSearchWords

* Update Documentation.highlightSearchWords

* Update Documentation.initDomainIndexTable

* Use arrow functions and const

* Replace $(document).ready

* Strict mode

* Move Documentation.hideSearchWords next to Documentation.highlightSearchWords

* Update translation functions in Documentation

* Replace $(document).ready in searchtools.js

* Update Scorer

* Update Search.hasIndex, Search.deferQuery, Search.stopPulse

* Prefer window.location

* Update Search.init

* Update Search.loadIndex

* Update Search.setIndex

* Update Search.startPulse

* Add _escapeRegExp

* Update Search.makeSearchSummary

* Update Search.htmlToText

* Update Search.performSearch

* Factor out _displayNextItem

* Update Search.query

* Update Search.performObjectSearch

* Update Search.performTermsSearch

* Remove underscores.js setup

* Use Sets

* Update test configuration

* Fix test failures

* Drop unused make/get URL functions

* Strict mode in searchtools.js

* Remove outmoded check for jQuery and underscore.js

* Ran prettier

prettier --print-width 120 --no-semi --quote-props as-needed --no-bracket-spacing --arrow-parens avoid --write sphinx/themes/basic/static

* Remove more references to jQuery and underscore.js

* Remove jQuery and underscore.js licences

* Update classic theme for no jQuery

* Update all other themes for no jQuery

* Restore jQuery & underscores.js to Sphinx themes

Enables a more gradual deprecation

* Added deprecation note to CHANGES

* Run prettier with defaults

* Update deprecation message to include extensions, note that sources must be copied

* oops

* Address Pradyun's feedback

* Forgot this one

* `let` doesn't work, as it is scoped to the block...

* Remove missed jQuery in sphinx13 theme
 2022-01-30 20:27:12 +01:00
Takeshi KOMIYA
b0b51cecc2 Close #10146: autodoc: autodoc_default_options does not support no-value option 2022-01-31 01:51:37 +09:00
Takeshi KOMIYA
799385f555 Merge pull request #9337 from marxin/new-shortcuts 
Implement new search shortcuts.
 2022-01-31 00:11:45 +09:00
Takeshi KOMIYA
07110b7557 Merge pull request #10132 from tk0miya/10122_install_check_in_make.bat 
Fix #10122: make.bat should check the installation before help
 2022-01-30 23:54:37 +09:00
Takeshi KOMIYA
eaefbef1eb Fix #9876: autodoc: ocument a class on binary module 2022-01-30 23:52:12 +09:00
Takeshi KOMIYA
f97ca41cfd Fix the order of CHANGES 2022-01-30 23:37:24 +09:00
Takeshi KOMIYA
13011703ea Fix #10122: make.bat should check the installation before help 2022-01-30 23:36:52 +09:00
Takeshi KOMIYA
c75e43a321 Merge pull request #10136 from tk0miya/10133_autodoc_mocked_module 
Fix #10133: autodoc: Crashed when mocked module is used for type annotation
 2022-01-30 23:35:54 +09:00
Takeshi KOMIYA
444e27865d Fix #10133: autodoc: Crashed when mocked module is used for type annotation 2022-01-30 23:19:55 +09:00
Takeshi KOMIYA
d8a398bbdd Close #10125: extlinks: Improve suggestion message for a reference having title 2022-01-23 20:09:47 +09:00
Martin Liska
8cf3179ad2 Implement new shortcuts: 
- "/" for Focus search bar
- "ESC" - clear highlighted text

Fixes #691.

Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
 2022-01-22 16:16:35 +01:00
Takeshi KOMIYA
72bb5c998f Close #9456: html search: Add a config variable; html_show_search_summary 
refs: #9494
 2022-01-17 01:44:42 +09:00
Takeshi KOMIYA
444dfc50aa Merge branch '4.x' 2022-01-17 00:22:09 +09:00
Takeshi KOMIYA
bd55cce6e6 Bump version 2022-01-17 00:21:22 +09:00
Takeshi KOMIYA
99947d9b18 Bump version 2022-01-17 00:19:41 +09:00
Takeshi KOMIYA
88f9647a22 Bump to 4.4.0 final 2022-01-17 00:17:38 +09:00
Jakob Lykke Andersen
9a3f2b8542 intersphinx role, CHANGES 2022-01-16 09:48:06 +01:00
Takeshi KOMIYA
da3981ae30 Update CHANGES for PR #10101 2022-01-16 03:04:01 +09:00
Takeshi KOMIYA
453e0c798e Merge pull request #10100 from tk0miya/9413_xml_namespace 
Fix #9413: xml: Invalid XML was generated when cross referencing python objects
 2022-01-16 02:49:01 +09:00
Takeshi KOMIYA
3b8387f469 Merge pull request #10097 from tk0miya/10029_strip_value_from_cmdoption 
Fix #9981: std domain: Strip value part of the option directive from genindex
 2022-01-16 02:44:24 +09:00
Takeshi KOMIYA
6a0215198f Merge branch '4.x' 2022-01-16 02:26:11 +09:00
Takeshi KOMIYA
76c9b3c605 Fix #9413: xml: Invalid XML was generated when cross referencing python objects 2022-01-16 02:02:12 +09:00
Takeshi KOMIYA
44e6d0ce2a doc: Remove a mention to :dedent: 0 
`:dedent: 0` option for the code-block directive is a secret feature.
So it should not be mentioned in our docs.
 2022-01-15 19:59:47 +09:00
Takeshi KOMIYA
6611140c76 Merge branch '4.x' into HEAD 2022-01-15 19:46:45 +09:00
Takeshi KOMIYA
0938c193ea Update CHANGES for PR #10099 2022-01-15 15:18:36 +09:00
Takeshi KOMIYA
8ba20898b4 Update CHANGES for PR #9551 2022-01-14 02:56:47 +09:00
Takeshi KOMIYA
008005cc39 Fix #9981: std domain: Strip value part of the option directive from genindex 2022-01-14 02:25:00 +09:00
Takeshi KOMIYA
49196d4474 Update CHANGES for PR #10091 2022-01-13 01:40:59 +09:00
Takeshi KOMIYA
e4e58a4f27 Close #10062: Change the default language to 'en' 
Change the default language to `'en'` if any language is not set in
`conf.py`.
 2022-01-12 02:45:52 +09:00
Takeshi KOMIYA
3ed92651d5 Merge pull request #10068 from tk0miya/10057_scanning_docs_on_root 
Fix #10057: Failed to scan documents on the root directory
 2022-01-12 02:42:08 +09:00
Takeshi KOMIYA
9a42e42a40 Merge pull request #10069 from tk0miya/10055_ensuredir_for_warnfile 
Close #10055: sphinx-build: Create directories when `-w` option given
 2022-01-12 02:35:15 +09:00
Takeshi KOMIYA
99c144d8cd Merge pull request #10079 from tk0miya/10061_confval_added_by_themes_not_initialized 
Fix #10061: html theme: Confvals added by themes are not initialized
 2022-01-12 02:34:52 +09:00
Takeshi KOMIYA
7f0166780f Fix #10058: autosummary: Imported members are not shown 
Originally, the `check_module()` call was added at 21b8384 to hide
imported members on generating stubs.  But it was incorrect approach.
Therefore it was disabled by b433197 and fixed the original issue by
another approach at 2390c554.

Finally, the `check_module()` call becomes meaningless code.  But, at
present, it causes that imported members are not shown when
`autodoc_class_signature` is 'separated'.  To resolve the problem, this
removes the meaningless call.
 2022-01-11 02:18:29 +09:00
Takeshi KOMIYA
2a3ea2e490 Fix #10061: html theme: Confvals added by themes are not initialized 2022-01-10 19:04:44 +09:00
Takeshi KOMIYA
ce41a5e3f0 Close #10055: sphinx-build: Create directories when -w option given 2022-01-09 04:04:31 +09:00
Takeshi KOMIYA
ce99cd4832 Fix #10057: Failed to scan documents on the root directory 
get_matching_files() incorrectly drops the first character of each
path on scanning documents.  It will help users to exclude paths
via exclude_patterns setting.

Note: Users need to configure `exclude_patterns` to put their document
on the root directory.  This does not help to avoid recursive symlinks
(ex. /proc, /sys)
 2022-01-09 03:57:55 +09:00
Takeshi KOMIYA
fe338f603b Merge branch 'master' into 9595_deprecate_setuptools_integration 2022-01-02 18:18:01 +09:00
Takeshi KOMIYA
616f112e6a autodoc: The default of autodoc_typehints_format becomes to 'smart' 
The default value of autodoc_typehints_format configuration is changed
to `'smart'`.  It will suppress the leading module names of typehints
(ex. `io.StringIO` -> `StringIO`).

refs: #9075
 2022-01-02 17:35:19 +09:00
Takeshi KOMIYA
2d92be7a1a Merge pull request #10036 from tk0miya/9555_autosummary_raise_ImportExceptionGroup_by_default 
autosummary: autosummary: import_by_name() now raises ImportExceptionGroup
 2022-01-02 13:03:10 +09:00
Takeshi KOMIYA
808a8d23ea autosummary: autosummary: import_by_name() now raises ImportExceptionGroup 
It starts to `ImportExceptionGroup` exception instead of `ImportError` by default
when it failed to import target object.
 2022-01-02 12:08:13 +09:00
Takeshi KOMIYA
0663602bb9 Close #9595: Deprecate setuptools integration 2022-01-01 20:19:27 +09:00
Takeshi KOMIYA
bdc241a678 CHANGES: Fix the location of the deprecation entry 2022-01-01 20:01:13 +09:00
Takeshi KOMIYA
6ee3dd1968 Merge branch '4.x' 2022-01-01 19:02:09 +09:00
Takeshi KOMIYA
b22134dcd3 Merge pull request #10031 from tk0miya/9555_ImportExceptionGroup_for_autosummary 
Close #9555: autosummary: Improve error messages on failure to load target object
 2022-01-01 19:00:10 +09:00
Takeshi KOMIYA
9039991a3b Close #9555: autosummary: Improve error messages on failure to load target object 2021-12-30 23:51:15 +09:00
Takeshi KOMIYA
eed0730b4b Merge pull request #10021 from tk0miya/10015_typehints_format_with_typehints_in_description 
Fix #10015: autodoc: autodoc_typehints_format='short' does not work when autodoc_typehints='description'
 2021-12-29 02:09:35 +09:00