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,350 Commits 2 Branches 219 Tags 163 MiB
4fcc64423d
Commit Graph

11350 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
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
Takeshi KOMIYA
e623739eff
Merge pull request #5309 from tk0miya/5306_NameError_for_invalid_typehints 
Fix #5306: autodoc: ``getargspec()`` raises NameError for invalid typehints
 2018-08-17 22:10:56 +09:00
Jakob Lykke Andersen
9cddc344db
Merge pull request #5311 from jakobandersen/cpp_new_delete_expr 
C++, add parsing of new and delete expressions
 2018-08-17 14:33:06 +02:00
Takeshi KOMIYA
2fb786cbb6
Merge pull request #5310 from tonyroberts/master 
Add PyXLL to EXAMPLES
 2018-08-17 21:06:25 +09:00
Jakob Lykke Andersen
73ae1ac834 C++, add parsing of basic new expressions. 2018-08-17 13:49:44 +02:00
Tony Roberts
d299869313 Add PyXLL to EXAMPLES 2018-08-17 12:43:24 +01:00
Takeshi KOMIYA
7975d73a17 Fix #5306: autodoc: emit a warning for invalid typehints 2018-08-17 10:39:02 +09:00
Takeshi KOMIYA
a450eb7a7a Fix #5306: autodoc: `getargspec()` raises NameError for invalid typehints 2018-08-17 10:32:58 +09:00
Timotheus Kampik
3834c6a3b7
Merge pull request #5295 from TimKam/update-karma-dependency 
Update karma dependency for JS tests
 2018-08-16 21:18:41 +02:00
Takeshi KOMIYA
2604920232
Merge pull request #5305 from tk0miya/5211_autodoc_for_partial_functions 
Fix #5211: autodoc: No docs generated for functools.partial functions
 2018-08-17 02:06:20 +09:00
Takeshi KOMIYA
c4fa1aed34 Fix #5211: autodoc: No docs generated for functools.partial functions 2018-08-17 01:24:19 +09:00
Takeshi KOMIYA
11331c5923 Merge branch '1.7' 2018-08-17 00:56:35 +09:00
Takeshi KOMIYA
b926ee8aeb
Merge pull request #5304 from tk0miya/5298_imgmath_two_numbers 
Fix #5298: imgmath: math_number_all causes equations to have two numbers in html
 2018-08-17 00:45:18 +09:00
Takeshi KOMIYA
c8e695fe2c Update CHANGES for PR #5273 2018-08-17 00:34:31 +09:00
Takeshi KOMIYA
28131df93e
Merge pull request #5307 from akaihola/5273_doctest_conditional_skip 
Feature: skip doctests conditionally
 2018-08-17 00:33:29 +09:00
Takeshi KOMIYA
4b3fc81122
Merge branch '1.7' into 5298_imgmath_two_numbers 2018-08-17 00:08:54 +09:00
Takeshi KOMIYA
01f4d3ba23
Merge pull request #5303 from tk0miya/5291_autodoc_crashed_by_ForwardRef 
Fix #5291: autodoc crashed by ForwardRef types
 2018-08-17 00:07:14 +09:00
Antti Kaihola
098f37fddf Ref #5273: doctest: add test for skipif calling global setup/cleanup 
Ensure that `doctest_global_setup` and `doctest_global_cleanup` are executed
before and after evaluating each `:skipif:` option.
 2018-08-16 17:56:29 +03:00
Antti Kaihola
d52488f028 Ref #5273: doctest: added a missing type hint 2018-08-16 14:56:53 +03:00
Antti Kaihola
5ffc924940 Ref #5273: doctest: added a missing final newline 2018-08-16 14:09:06 +03:00
Antti Kaihola
43d5810083 Ref #5273: doctest: add documentation for the :skipif: option 2018-08-16 14:01:57 +03:00
Antti Kaihola
9185c2c356 Ref #5273: doctest: add tests for the :skipif: option 2018-08-16 13:22:59 +03:00