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
11,371 Commits 2 Branches 219 Tags 163 MiB
18f107b0bc
Commit Graph

11371 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Takeshi KOMIYA
18f107b0bc autodoc: Fix typing.get_type_hints() raises AttributeError for partial objects 2018-08-25 10:57:34 +09:00
Takeshi KOMIYA
ea3d0b3768 Merge branch '1.7' into 1.8 2018-08-25 03:07:35 +09:00
Takeshi KOMIYA
d4bce1debd
Merge pull request #5344 from tk0miya/upgrade_python_on_circleci 
test: Upgrade python on Circle CI to 3.5
 2018-08-25 03:07:18 +09:00
Takeshi KOMIYA
520797a5e8 test: Upgrade python on Circle CI to 3.5 2018-08-25 02:53:17 +09:00
Takeshi KOMIYA
e7e1ffe6dc
Merge pull request #5332 from tk0miya/5325_latex_broken_xref 
Fix #5325: latex: cross references has been broken by multiply labeled objects
 2018-08-22 22:40:10 +09:00
Takeshi KOMIYA
a029a8f81d
Merge pull request #5333 from tk0miya/5322_Any_causes_crashed 
Fix #5322: autodoc: ``Any`` typehint causes formatting error
 2018-08-22 22:38:21 +09:00
Takeshi KOMIYA
8b6a12d5d6
Merge branch '1.7' into 5322_Any_causes_crashed 2018-08-22 21:58:47 +09:00
Takeshi KOMIYA
7c2f355490
Merge pull request #5330 from tk0miya/5326_invalid_docname_of_man_pages 
Fix #5326: manpage: crashed when invalid docname is specified as ``man_pages``
 2018-08-22 21:57:18 +09:00
Takeshi KOMIYA
3eb7757357
Merge branch '1.8' into 5325_latex_broken_xref 2018-08-22 21:33:32 +09:00
Takeshi KOMIYA
ce09a73a68
Merge branch '1.7' into 5326_invalid_docname_of_man_pages 2018-08-22 21:16:52 +09:00
Takeshi KOMIYA
ee604144c6 Fix #5326: manpage: crashed when invalid docname is specified as `man_pages` 2018-08-22 21:03:33 +09:00
Takeshi KOMIYA
386ae1ceac
Merge pull request #5323 from tk0miya/dont_use_document.current_source 
graphviz: Don't use document.current_source
 2018-08-22 20:52:58 +09:00
Takeshi KOMIYA
0479e1f09b
Merge pull request #5329 from tk0miya/fix_searchbox_overrides 
Fix html: search box overrides to other elements if scrolled
 2018-08-22 20:43:04 +09:00
Takeshi KOMIYA
2b236b90ec
Merge pull request #5331 from tk0miya/5320_intersphinx_crashed 
Fix #5320: intersphinx: crashed if invalid url given
 2018-08-22 20:38:35 +09:00
Takeshi KOMIYA
59a766d7d6 Fix #5322: autodoc: `Any` typehint causes formatting error 2018-08-22 19:57:27 +09:00
Takeshi KOMIYA
32ba112091 Fix #5325: latex: cross references has been broken by multiply labeled objects 2018-08-22 18:17:54 +09:00
Takeshi KOMIYA
bde53bf9fb Fix #5320: intersphinx: crashed if invalid url given 2018-08-22 15:28:16 +09:00
Takeshi KOMIYA
59bc1da6ae Fix html: search box overrides to other elements if scrolled 2018-08-22 14:33:48 +09:00
Takeshi KOMIYA
7065c1cb39
Merge pull request #5328 from tk0miya/fix_typo 
Fix typo
 2018-08-22 11:40:44 +09:00
Takeshi KOMIYA
472001eeb7 Fix typo 2018-08-22 11:08:33 +09:00
Takeshi KOMIYA
00f476040e graphviz: Don't use document.current_source 2018-08-21 21:59:16 +09:00
Takeshi KOMIYA
4fcc64423d Bump version 2018-08-21 01:19:45 +09:00
Takeshi KOMIYA
00e40cc32d Bump to 1.8.0 beta1 2018-08-21 01:17:15 +09:00
Takeshi KOMIYA
db8865a46d
Merge pull request #5063 from jakobandersen/search_use_dispname 
Search: make a difference between fullname and dispname
 2018-08-20 22:15:03 +09:00
Takeshi KOMIYA
e3f383ad7c
Merge pull request #5315 from tk0miya/add_autodoc_default_options 
Add autodoc_default_options
 2018-08-20 00:26:08 +09:00
Takeshi KOMIYA
b7345ea3a4 Update CHANGES for PR #5297 2018-08-20 00:19:57 +09:00
Takeshi KOMIYA
8591ac8705 Merge branch 'master' of github.com:sphinx-doc/sphinx 2018-08-20 00:15:06 +09:00
Takeshi KOMIYA
e4037f85cb Update CHANGES for PR #4000 2018-08-20 00:14:41 +09:00
Takeshi KOMIYA
ad8129b695 Merge branch 'master' into template-body 2018-08-20 00:10:14 +09:00
Takeshi KOMIYA
a4eec9f9fd Remove unused testcases 2018-08-20 00:10:11 +09:00
Takeshi KOMIYA
17874a1a4b
Merge pull request #5297 from AWhetter/viewcode_follow_imported_event 
Plugins can resolve imported members for viewcode
 2018-08-19 23:45:09 +09:00
Takeshi KOMIYA
ffc6e1d552 Merge branch '1.7' 2018-08-19 23:20:33 +09:00
Takeshi KOMIYA
2371614227 Bump version 2018-08-19 23:16:34 +09:00
Takeshi KOMIYA
f9027c6daf Bump to 1.7.7 final 2018-08-19 23:14:03 +09:00
Takeshi KOMIYA
b50b73e80d
Merge pull request #5312 from tk0miya/5294_quickstart_colorscheme_for_windows 
Fix #5294: sphinx-quickstart blank prompts in PowerShell
 2018-08-19 13:12:14 +09:00
Jakob Lykke Andersen
1c2dff16b0
Merge pull request #5314 from jakobandersen/cpp_overload 
C++, support for cross-references to specific function overloads
 2018-08-18 21:41:31 +02:00
Takeshi KOMIYA
7f52ef7512 Merge branch '1.7' 2018-08-19 02:19:06 +09:00
Takeshi KOMIYA
3d9e2cf831 Add autodoc_default_options 2018-08-18 18:22:16 +09:00
Takeshi KOMIYA
6e06ec2f37
Merge pull request #5313 from tk0miya/5198_note_included_on_parallel_build 
Fix #5198: document not in toctree warning when including files only for parallel builds
 2018-08-18 18:11:40 +09:00
Jakob Lykke Andersen
1c035d7203 C++, add support for overload-specific references. 
The "any" and "func" roles now accepts full function declarations.

Fixes #1552
 2018-08-18 08:27:23 +02:00
Jakob Lykke Andersen
3348b9255f C++, unify symbol lookup algorithms 2018-08-18 08:27:23 +02:00
Jakob Lykke Andersen
6b98eb76f9 C++, improve type info 2018-08-18 08:27:23 +02:00
Takeshi KOMIYA
07c3f24aad Update CHANGES for PR #5215 2018-08-18 15:17:00 +09:00
Takeshi KOMIYA
00072ec0e7
Merge pull request #5215 from LewisHaley/lewis/allow-setting-audodoc-default-options-in-conf 
Allow setting audodoc default options in conf
 2018-08-18 15:13:02 +09:00
Takeshi KOMIYA
e8c6b70de6 Fix #5198: document not in toctree warning when including files only for parallel builds 2018-08-18 14:53:58 +09:00
Takeshi KOMIYA
fa8b84a12f
Merge pull request #5308 from tk0miya/5306_warning_for_invalid_typehints 
Fix #5306: autodoc: emit a warning for invalid typehints
 2018-08-18 12:05:59 +09:00
Lewis Haley
f196a92055 autodoc: add 'exclude-members' to user global options 
As the previous commit explains, it is now possible to specify arguments
to the global options in config files. This means that we can now include
the `exclude-members` option in this global configuration.

Previously, there was no point including this option because it makes no
sense without arguments. Including this option means users have the
flexibility of explicitly including which special methods they want using
(e.g.):

  :special-members: __init__, __iter__

or explicitly excluding which special-members (or other members) they want
using (e.g.):

  :exclude-members: __weakref__, __hash__
 2018-08-17 16:02:11 +01:00
Lewis Haley
6e1e35c98a autodoc: allow specifying values to global arguments 
Previously, users could specify a *list* of flags in their config files.
The flags were directive names that would otherwise be present in the
.rst files. However, as a list, it was not possible to specify values
to those flags, which *is* possible in .rst files.

For example, in .rst you could say

  :special-members: __init__, __iter__

And this would cause autodoc to generate documents for these methods that
it would otherwise ignore.

This commit changes the config option to instead accept a dictionary.
This is a dictionary whose keys can contain the same flag-names as before,
but whose values can contain the arguments as seen in .rst files.

The old list is still supported, for backwards compatibility, but the data
is transformed into a dictionary when the user's config is loaded.
 2018-08-17 15:51:00 +01:00
Lewis Haley
87029392fd test_autodoc: fix mutable function default argument in do_autodoc 
Setting mutable types as default arguments is bad practice because the
value is only initialised once. This means that defaults arguments of
lists and dictionaries which are modified during code execution *stay*
modified between calls.

In this case, the `options` dictionary accumulated options as more and
more test cases were executed. Without this change, the tests added in
the next commit do not pass.

See: https://stackoverflow.com/questions/1132941/least-astonishment-and-the-mutable-default-argument
 2018-08-17 15:33:58 +01:00
Takeshi KOMIYA
a22f9df684 Fix #5294: sphinx-quickstart blank prompts in PowerShell 2018-08-17 22:25:13 +09:00