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
16,435 Commits 2 Branches 219 Tags 163 MiB
ac7d574fce
Commit Graph

16435 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
36e684bf83 refactor: Move _getmro() to sphinx.util.inspect module 2020-12-17 00:46:42 +09:00
Takeshi KOMIYA
bec552c3ef
Merge pull request #8540 from tk0miya/8534_autoattribute_alias 
Fix #8534: autoattribute failed to document a commented attribute in alias class
 2020-12-16 23:47:21 +09:00
Takeshi KOMIYA
caa1d1f3c2 Fix #8534: autoattribute failed to document a commented attribute in alias class 
So far, autoattribute uses "given class name" to fetch comments of
uninitialized instance attributes.  But pycode expects to use "real"
class name on searching attribute comments.

This adds UninitializedInstanceAttributeMixin to handle it simply.
 2020-12-16 02:43:31 +09:00
Takeshi KOMIYA
3e46fda759 refactor: autodoc: Add NonDataDescriptorMixin 2020-12-16 02:36:34 +09:00
Takeshi KOMIYA
00db1ea631
Merge pull request #8538 from jdufresne/os-replace 
Deprecate sphinx.util.osutil.movefile() in favor of os.replace()
 2020-12-14 23:43:00 +09:00
Takeshi KOMIYA
edb1999ac2 Update CHANGES for PR #8524 2020-12-14 23:40:28 +09:00
Takeshi KOMIYA
18b7202627
Merge pull request #8524 from rkdarst/rkdarst/template-document-options-url_root 
sphinx/themes/basic/layout: Set url_root properly on index, don't use '#'
 2020-12-14 23:36:29 +09:00
Jon Dufresne
cb4f76fca2 Deprecate sphinx.util.osutil.movefile() in favor of os.replace() 
The utility function movefile() was added in
677d096393 to handle existing files on
Windows. Since Python 3.3, the stdlib function os.replace() fills this
role.
 2020-12-13 09:36:10 -08:00
Richard Darst
21aecb14a7 sphinx/themes/basic/layout: Set url_root properly on index, don't use '#' 
- url_root is set to `#` on the index page, which layout.html tries to
  change back to `''` (the empty string).
- But, this updated url_root wasn't used in the actual location, as an
  argument to `documentation_options.js`.
- Thus, clever enough templates, which tried to use
  `$DOCUMENTATION_OPTIONS.URL_ROOT` inside javascript would fail.
  This was manifested as broken links, which led to this issue:
  https://github.com/executablebooks/sphinx-copybutton/issues/110
- I have eventually traced that back to sphinx itself, and found that
  layout.html tried to fix the problem, but the fixed value wasn't
  used.
- This fix works in my basic test, but I will continue with more tests.
- Review:
  - someone more clever should examine this and make sure it makes
    sense
  - This does not have tests.  Should it?
 2020-12-13 19:12:07 +02:00
Takeshi KOMIYA
5b28d77b37 Merge branch '3.3.x' into 3.x 2020-12-14 01:49:17 +09:00
Takeshi KOMIYA
8ed1e706cc
Merge pull request #8527 from tk0miya/8111_pretty_change 
refactor: pretty change for isproperty()
 2020-12-14 01:33:01 +09:00
Takeshi KOMIYA
399210c807
Merge pull request #8533 from tk0miya/deprecate_no_docstring 
refactor: Deprecate `no_docstring` argument for Documenter.add_content()
 2020-12-14 01:32:42 +09:00
Takeshi KOMIYA
368c223f08
Merge pull request #8535 from nedbat/nedbat/more-about-intersphinx 
Describe the intersphinx mapping a bit more
 2020-12-13 22:41:25 +09:00
Ned Batchelder
bac6ab8d0c Describe the intersphinx mapping a bit more 2020-12-13 08:04:55 -05:00
Jakob Lykke Andersen
3a85c005a7
Merge pull request #8531 from jakobandersen/bnavigator-fix-AliasNode-copy 
C, fix AliasNode.copy, correct branch
 2020-12-12 18:53:46 +01:00
Takeshi KOMIYA
3638a9e4d1 refactor: Deprecate no_docstring argument for Documenter.add_content() 
This deprecates `no_docstring` argument for Documenter.add_content().
After this change, please use Documenter.get_doc() to control (suppress)
the content of the python object.
 2020-12-13 02:11:53 +09:00
Jakob Lykke Andersen
c777a90816
Merge pull request #8530 from jakobandersen/bnavigator-fix-AliasNode-copy 
C, fix AliasNode.copy
 2020-12-12 17:47:08 +01:00
Jakob Lykke Andersen
43113594aa Update CHANGES 2020-12-12 17:27:47 +01:00
Jakob Lykke Andersen
b7c7adfd18 C++, typing on AliasNode.copy 2020-12-12 17:26:27 +01:00
Ben Greiner
e35639299d Fix mypy type error 2020-12-12 17:24:25 +01:00
Ben Greiner
61556e3410 Fix AliasNode.copy() 2020-12-12 17:24:25 +01:00
Takeshi KOMIYA
8823d1c528
Merge pull request #8528 from jdufresne/drop-workaround 
Drop outdated workaround for distutils' Command._ensure_stringlike()
 2020-12-13 00:11:15 +09:00
Takeshi KOMIYA
d5e13324e8
Merge pull request #8529 from jdufresne/dup-test 
Remove duplicate test in test_ext_autodoc.py
 2020-12-12 23:55:10 +09:00
Jon Dufresne
850512090a Remove duplicate test in test_ext_autodoc.py 
Duplicate since c6bd84a614.
 2020-12-12 06:28:23 -08:00
Jon Dufresne
0938bdb2a8 Drop outdated workaround for distutils' Command._ensure_stringlike() 
The issue applied to Python 2 only. The current override is identical to
the CPython implementation:

4b8cdfcb22/Lib/distutils/cmd.py (L207-L215)
 2020-12-12 06:17:59 -08:00
Takeshi KOMIYA
e15f7a1f02 refactor: pretty change for isproperty() 
It is more readable to use `>=` to compare versions.
 2020-12-12 18:54:53 +09:00
Takeshi KOMIYA
8faa8ba7ab Update CHANGES for PR #8523 2020-12-12 15:16:51 +09:00
Takeshi KOMIYA
9d96c07133
Merge pull request #8523 from ArtyomKaltovich/fix_bool_issue 
fix #8522: sphinx could lead to `__bool__` method call, what can lead to side effect or direct failure in case it generate an error bug
 2020-12-12 15:15:57 +09:00
ArtyomKaltovich
2276351458
Merge branch '3.x' into fix_bool_issue 2020-12-08 13:07:34 -05:00
Artyom Kaltovich
964b9824d7 fix CHANGES 2020-12-08 21:04:53 +03:00
Takeshi KOMIYA
e35770f023 Update CHANGES for PR #8519 2020-12-09 02:00:09 +09:00
Toni Ruža
a8f5341d88 Fold long line 2020-12-09 01:59:13 +09:00
Toni Ruža
6fc83981b3 Prevent page brake in the middle of a seealso 2020-12-09 01:59:06 +09:00
Artyom Kaltovich
5be21b4baa fix typo 2020-12-07 14:40:12 +03:00
Artyom Kaltovich
612479dcf0 fix bullet list 2020-12-07 14:38:58 +03:00
Artyom Kaltovich
6fdbce933b fix_8522 2020-12-07 14:31:10 +03:00
Jeremy Maitin-Shepard
d737ecd063 Fix nonascii_srcdir to work when non-ascii directories aren't supported 
Previously, the nonascii_srcdir in tests/test_build.py contained some
logic to attempt to handle the case where non-ascii directories aren't
supported, but it did not actually work because it fails to copy the
test sources to the temporary directory.

With this commit, the following test invocation, which previously
failed, now pases:

LANG=en_US.iso8859-1 python -m pytest test_build.py
 2020-11-30 13:13:01 -08:00
Takeshi KOMIYA
9cf2826491
Merge pull request #8506 from tk0miya/8352_option_startswith_bracket 
Fix #8352: std domain: Failed to parse an option that starts with bracket
 2020-11-29 23:58:18 +09:00
Takeshi KOMIYA
cafb8bfe92
Merge pull request #8507 from tk0miya/refactor_html_events_registration 
refactor: Register events for HTML builders in the HTML builder module
 2020-11-29 23:57:47 +09:00
Takeshi KOMIYA
aa84eea08b
Merge pull request #8504 from tk0miya/deprecate_GenericAliasDocumenter 
Fix #8503: autoattribute could not create document for a GenericAlias
 2020-11-29 12:50:19 +09:00
Takeshi KOMIYA
bb63f03034 Fix #8503: autoattribute could not create document for a GenericAlias 2020-11-29 12:24:10 +09:00
Takeshi KOMIYA
c15c61ed64
Merge pull request #8505 from tk0miya/8501_extract_summary_el_at 
Fix #8501: autosummary: summary extraction splits text after "el at."
 2020-11-29 11:48:55 +09:00
Takeshi KOMIYA
233cdc1063
Merge pull request #8502 from tk0miya/refactor_autodoc_depraction 
refactor: autodoc: Move deprecated documenters to autodoc.deprecated package
 2020-11-29 11:48:14 +09:00
Takeshi KOMIYA
aa1978fe20
Merge pull request #8500 from tk0miya/refactor_UninitializedGlobalVariableMixin 
refactor: autodoc: Add UninitializedGlobalVariableMixin
 2020-11-29 11:47:24 +09:00
Takeshi KOMIYA
6a88e64fd0 refactor: Register events for HTML builders in the HTML builder module 2020-11-29 02:31:28 +09:00
Takeshi KOMIYA
bae7ab9c9d Update CHANGES for PR #8291 2020-11-29 02:30:42 +09:00
Takeshi KOMIYA
6d24579f40 Fix #8352: std domain: Failed to parse an option that starts with bracket 2020-11-29 02:22:40 +09:00
Takeshi KOMIYA
e4bd3bd3dd Update CHANGES for PR #8494 2020-11-28 22:56:12 +09:00
Takeshi KOMIYA
3f3358b38f
Merge pull request #8494 from timoludwig/alias-of-builtin 
Use restify() to reference alias attributes in autodoc
 2020-11-28 22:55:27 +09:00
Timo Ludwig
ccfd98dc07
Fix #8493: Use restify() in autodoc to reference alias attributes 2020-11-28 12:12:02 +01:00