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
13,361 Commits 2 Branches 219 Tags 163 MiB
afefeebb52
Commit Graph

177 Commits

Author SHA1 Message Date
Shingo Kitagawa
51f7d351a1 fix issue #4885 
https://github.com/sphinx-doc/sphinx/issues/4885
 2018-04-24 00:22:18 +09:00
Shingo Kitagawa
3735ba39db fix issue #4885 
https://github.com/sphinx-doc/sphinx/issues/4885
 2018-04-23 17:21:02 +09:00
Takeshi KOMIYA
985886a7fc Merge branch '1.7' 2018-04-23 01:32:12 +09:00
Takeshi KOMIYA
f4f693eff7 #4459: duplicated labels detector does not work well in parallel build 2018-04-22 19:20:12 +09:00
Takeshi KOMIYA
9efaf18852 Merge branch '1.7' 2018-03-18 01:21:01 +09:00
Takeshi KOMIYA
4cebc4399c Merge commit '6694981dd6939ab876b27d4e20a8128561c307ac' 2018-03-15 02:02:21 +09:00
Takeshi KOMIYA
70a622b86c Revert "Use typing.TYPE_CHECKING for typehints" 
This reverts commit a073e17537.
 2018-03-13 23:23:15 +09:00
Takeshi KOMIYA
6faef28150 Make console and warning messages translatable 2018-03-03 23:18:38 +09:00
Takeshi KOMIYA
ad7d77d010 refactor: Move pairindextypes to sphinx.domains.python 2018-03-03 02:54:55 +09:00
Takeshi KOMIYA
6872d5b337 Fix pydomain: always strip parenthesis if empty (refs: #1042) 2018-03-03 01:41:49 +09:00
Takeshi KOMIYA
aba26657c5 Replace `l_() by _()` 2018-02-25 02:03:57 +09:00
Takeshi KOMIYA
f8bb40ab30 Merge branch '1.7' 2018-02-18 12:39:07 +09:00
Takeshi KOMIYA
a073e17537 Use typing.TYPE_CHECKING for typehints 2018-02-14 22:57:38 +09:00
Takeshi KOMIYA
4647fcee45 Merge branch '1.7-release' 2018-01-31 20:40:56 +09:00
Takeshi KOMIYA
9f5c676322 Use flake8-import-order 2018-01-28 01:52:16 +09:00
Takeshi KOMIYA
32c5e8346f Close #4460: extensions should return the version of data structure as metadata 2018-01-25 02:04:22 +09: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
7e7b389eed Merge branch 'stable' 2017-10-23 12:23:58 +09:00
Takeshi KOMIYA
ffad4f08c7 Fix #3739: `:module:` option is ignored at content of pyobjects 2017-10-21 21:37:44 +09:00
Takeshi KOMIYA
d65c5c4ed8 Merge branch 'master' into 3866_suppress_pydomain_ref_warning 2017-07-17 17:42:23 +09:00
Sam Park
5873c9644d Python rtypes should match classes, not all objects 2017-07-15 14:33:52 -07:00
Andy Freeland
7046d17631 Python parameter/variable types should match classes, not all objects 
Parameter and variable types in the Python domain have the
counter-intuitive behavior of matching instance methods (or likely any
other objects) rather than classes, e.g.:

```python
class Foo(object):
    def list(self):
        """List some things."""

def bar(x):
    """
    :param x: x
    :type x: list
    """
```

`bar()` will link to `Foo.list()` rather than the standard library
`list` type.
 2017-07-12 21:52:38 -07:00
Takeshi KOMIYA
db88166a3f Fix #3866: Suppress a new warning type: python refs 2017-06-17 11:34:43 +09:00
Takeshi KOMIYA
c07ed92a20 Merge branch 'stable' into 1.6-release 2017-05-13 15:42:03 +09:00
Takeshi KOMIYA
4104b93c6e Fix #3320: Warning about reference target not being found for container types 2017-05-13 15:03:11 +09:00
Takeshi KOMIYA
b39b0191a7 Fix #3351: intersphinx does not refers context 2017-04-16 18:25:21 +09:00
Takeshi KOMIYA
1123c3bda6 Merge branch 'stable' 2017-04-04 00:38:49 +09:00
Takeshi KOMIYA
57019c291a Fix #3597: python domain raises UnboundLocalError if invalid name given 2017-04-02 22:55:40 +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
Takeshi KOMIYA
aa6dfb8b41 Merge branch 'stable' 2017-03-18 18:25:50 +09:00
Takeshi KOMIYA
a67c7855aa Merge pull request #3520 from agjohnson/fix-domain-py-nesting 
Fix Python domain nesting
 2017-03-18 17:33:56 +09:00
Anthony Johnson
2795889310 Review feedback, cleanup, and docs 2017-03-15 23:14:32 -07:00
jfbu
9d58a0b96c Split some long type-checking annotation lines 2017-03-12 13:20:55 +01:00
jfbu
bc0682af0e Merge branch 'stable' 
Conflicts resolved:
	sphinx/domains/cpp.py
	sphinx/domains/python.py
	sphinx/texinputs/sphinx.sty
	sphinx/util/docfields.py
	sphinx/writers/latex.py
	tests/test_build_latex.py

Also updated:
    sphinx/domains/__init__.py
 2017-03-12 13:01:47 +01:00
Jakob Lykke Andersen
9249db2472 Make docfield xref changes backwards compatible 2017-03-11 18:56:13 +09:00
Jakob Lykke Andersen
9ca5d990f6 Add callback on domains for xrefs from fields. 
Fixes sphinx-doc/sphinx#2607.
Fixes sphinx-doc/sphinx#2665.
 2017-03-08 20:35:44 +09:00
Anthony Johnson
b0875d63fc
Fix Python domain nesting 
Moved #3465 here, to address this in `stable` instead.

This fixes a problem with the Python domain object nesting. Because only one
object name was stored in `ref_context`, and reset to `None` in `after_content`,
nesting broke if you put anything after a nested class:

```rst
.. py:class:: Parent

    .. py:method:: foo()

        This wouldn't resolve: :py:meth:`bar`

    .. py:class:: Child

        In the `after_content` method, the object is reset to `None`, so
        anything after this in the same nesting is considered to be top level
        instead.

    .. py:method:: bar()

        This is top level, as the domain thinks the surrounding object is `None`
```

This depends on #3519 and can be rebased after that is merged into stable

Fixes #3065
Refs #3067
 2017-03-06 19:04:19 -08:00
Takeshi KOMIYA
554199d30e Upgrade to mypy-0.5 2017-03-03 23:17:34 +09:00
Takeshi KOMIYA
e1da72b59c Reduce DeprecationWarnings for regexp 2017-02-17 02:01:04 +09:00
Takeshi KOMIYA
029e9908c0 Remove unused "type: ignore" 2017-02-06 15:21:19 +09:00
Takeshi KOMIYA
38d6c34f35 Merge branch 'stable' 2017-01-12 13:03:53 +09:00
Takeshi KOMIYA
60d4846e0f Fix flake8 violations 2017-01-12 10:07:05 +09:00
Takeshi KOMIYA
ecd7b62148 Update type annotations 2017-01-09 18:14:53 +09:00
Takeshi KOMIYA
15b46598e2 logger.warning() supports node as location parameter 2017-01-02 12:59:51 +09:00
Takeshi KOMIYA
e755a8c004 Use loggers 2017-01-02 12:59:51 +09:00
Takeshi KOMIYA
d5288567fd Update type annotations 2016-12-15 19:22:40 +09:00
Takeshi KOMIYA
9abdaedb7c Merge branch 'master' into deprecate_sphinx.util.compat 2016-12-14 01:27:11 +09:00
Takeshi KOMIYA
e645ea59db Merge branch 'stable' 2016-12-14 00:12:23 +09:00
Takeshi KOMIYA
2df0bb8d03 `sphinx.util.compat.Directive` class is now deprecated. 2016-12-13 11:36:03 +09:00
Takeshi KOMIYA
d72954d498 builtin extensions return metadata to allow parallel build 2016-12-12 21:22:16 +09:00
Takeshi KOMIYA
8a06a42c31 Add type-check annotations to sphinx.domains 2016-11-16 12:06:22 +09:00
Ashley Whetter
ea86d23845 Python domain can link multiple types in a type field 2016-09-18 06:38:27 +01:00
Ashley Whetter
cfd4e51802 Python domain can now link container types automatically 
Google types now greedily match the closing parenthesis.

Also removed name from returns section in Google docstrings.
Instead, everything before the colon is treated as the type.
 2016-08-03 17:09:40 +01:00
Glenn Matthews
8c1a8153ca Create PyGroupedField and use it for 'exceptions' 2016-07-15 22:01:06 -04:00
Takeshi KOMIYA
8a45aa5e59 Now all builders and domains work as built-in extensions 2016-07-06 23:25:45 +09:00
shimizukawa
e6a5a3a92e classifier of glossary terms can be used for index entries grouping key. The classifier also be used for translation. See also :ref:glossary-directive. 2016-02-14 19:28:58 +09:00
Georg Brandl
46d7e8558e Obligatory copyright update. 2016-01-14 22:54:04 +01:00
shimizukawa
70612c610f fix #1772 cross reference in docstrings like `:param .write:` breaks building. 2015-03-14 18:54:20 +09:00
Georg Brandl
ba9dcaac51 more pep8 fixes 2015-03-08 16:59:27 +01:00
Georg Brandl
a23903d8d5 Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Georg Brandl
567d52f199 all: update copyright 2015-01-03 21:36:32 +01:00
Georg Brandl
6c194ad56f Closes #1623: Return types specified with `:rtype:` are now turned into links if possible. 2014-11-12 11:32:21 +01:00
Georg Brandl
31452fc64d [WIP] parallel read 2014-09-22 14:51:47 +02:00
Georg Brandl
6ba8883685 Add ref context to all "any" references. Should make it possible to resolve them more accurately. 2014-09-20 19:23:25 +02:00
Georg Brandl
2c396601bf Move env.temp_data content that might be used to resolve references to a new env.ref_context dictionary. 2014-09-20 19:15:41 +02:00
Georg Brandl
c3eb669f8a Added the any role that can be used to find a cross-reference of 
*any* type in *any* domain.  Custom domains should implement the new
`~Domain.resolve_any_xref` method to make this work properly.
 2014-09-19 12:59:18 +02:00
Takayuki Shimizukawa
da20c3713b merge with stable 2014-07-13 11:43:12 +09:00
Takayuki Shimizukawa
91709946d6 * Fix: py:function directive generate incorrectly signature when specifying a default parameter with an empty list []. Closes #1503 2014-07-12 20:50:15 +09:00
Takayuki Shimizukawa
49944cfa52 wrap iterator with list() to avoid 'dictionary changed size during iteration' on py3. refs #1350. 2014-04-29 22:43:58 +09:00
Takayuki Shimizukawa
ce4d342e20 use six privided iteritems(),itervalues() to support py2/py3 in one source. refs #1350. 2014-04-29 21:20:56 +09:00
Georg Brandl
ac92719ac3 Update copyright year. 2014-03-01 08:18:23 +01:00
Georg Brandl
e030031321 Update copyright year. 2014-03-01 08:18:16 +01:00
Georg Brandl
fc82989a35 merge with stable 2014-01-12 20:30:25 +01:00
Georg Brandl
12b3b49f22 Closes #1233: Allow finding both Python classes and exceptions with the "class" and "exc" roles in intersphinx. 2014-01-12 17:19:58 +01:00
Virgil Dupras
ea02a07562 Allow "." and "~" prefixes in inline :param: typedefs. 2014-01-04 21:40:52 -05:00
Georg Brandl
ff33545457 Closes #1159: do not emit duplicate inventory entries for py:module objects. 
Also add a workaround on the consumer side in intersphinx, so that links
to projects using old versions of Sphinx generate correct links.
 2013-09-16 07:54:12 +02:00
Georg Brandl
151856819c Copyright update. 2013-01-01 22:13:15 +01:00
Georg Brandl
a6512317bf Closes #864: Fix crash with some settings of :confval:modindex_common_prefix. 2012-01-29 10:43:31 +01:00
Georg Brandl
5727c053c2 Closes #859: Fix exception under certain circumstances when not finding appropriate objects to link to. 2012-01-29 10:25:34 +01:00
Georg Brandl
9a4a3c9afa Satisfy "make check". 2011-10-09 23:09:57 +02:00
Georg Brandl
4abbe95a9c Merge with 1.0 2011-09-23 11:03:23 +02:00
Georg Brandl
db87ed440c Fix #648: Fix line numbers reported in warnings about undefined references. 2011-09-23 09:46:24 +02:00
Georg Brandl
25d41d8ed1 Merge with 1.0 2011-09-23 08:06:12 +02:00
Georg Brandl
6e81a0622a Fix pyflakes issues. 2011-09-22 15:34:26 +02:00
Georg Brandl
5ca496847a Closes #669: Respect the `noindex` flag option in py:module directives. 2011-05-15 13:00:11 +02:00
Georg Brandl
7e3151dd73 #581: Fix traceback in Python domain for empty cross-reference targets. 2011-01-04 23:39:13 +01:00
Georg Brandl
0e1db6ad90 New year update. 2011-01-04 10:00:51 +01:00
Georg Brandl
205d50a01d Regression of #77: If there is only one parameter given with `:param:` markup, the bullet list is now suppressed again. 2011-01-03 23:08:13 +01:00
Georg Brandl
10287a6684 merge with 1.0 2011-05-15 13:52:48 +02:00
Georg Brandl
dc0c43da9a #437: autodoc now shows values of class data attributes. 2011-01-08 23:45:58 +01:00
Georg Brandl
a86d481925 #507: Fix crash parsing Python argument lists containing brackets in string literals. 2010-08-23 15:20:22 +00:00
Georg Brandl
580e1c90d3 #481, #482: fix `.name` reference matching. 
#482: When doing a non-exact search, match only the given type of object.
#481: Apply non-exact search for Python reference targets with ``.name`` for modules too.
 2010-08-05 13:39:23 +02:00
Georg Brandl
7139a1c882 The :rst:dir:py:module directive doesn't output its `platform` option value anymore. 
(It was the only thing that the directive did output, and therefore quite inconsistent.)
 2011-01-08 16:09:49 +01:00
Georg Brandl
c6028c4405 #478: Added :rst:dir:py:decorator directive to describe decorators. 2011-01-08 10:07:42 +01:00
Georg Brandl
bf767d5222 #454: Add more index markup capabilities: marking see/seealso entries, and main entries for a given key. 2011-01-07 19:00:29 +01:00
Georg Brandl
e8b0511fdc merge with 1.0 2011-01-04 23:40:57 +01:00
Georg Brandl
17efae5622 merge with 1.0 2011-01-04 11:29:09 +01:00
Georg Brandl
3642b521ed merge with 1.0 2011-01-04 00:35:27 +01:00