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
14,756 Commits 2 Branches 219 Tags 163 MiB
d9d381de11
Commit Graph

56 Commits

Author SHA1 Message Date
Takeshi KOMIYA
d9d381de11 Fix #7445: a return annotation `None` is not converted to a hyperlink 2020-04-10 02:07:02 +09:00
Takeshi KOMIYA
7aa5584a47 Fix #7301: capital characters are not allowed for node_id 2020-03-29 23:55:56 +09:00
Takeshi KOMIYA
fe9473f42e Fix #7219: py:module directive generates incorrect index entry 2020-03-29 19:37:21 +09:00
Takeshi KOMIYA
ce25d0080e Fix #7219: py:function directive generates incorrect index entry 2020-03-29 19:37:19 +09:00
Takeshi KOMIYA
8edae5fe28
Merge pull request #7356 from tk0miya/7301_node_id 
Fix #7301: Allow . and _ for node_id
 2020-03-22 23:42:56 +09:00
Takeshi KOMIYA
b0a6b3f285 Close #7341: py domain: type annotations are converted to cross refs 2020-03-22 17:10:00 +09:00
Takeshi KOMIYA
7bbf79c313 Fix #7301: Allow . and _ for node_id 
In development of 3.0, Sphinx starts to obey to the rule of
"Identifier Normalization" of docutils.  This extends it to allow
dots(".") and underscores("_") for node identifier.

It allows Sphinx to generate node identifier from source string as
possible as it is (bacause dots and underscores are usually used in
many programming langauges).

This change will keep not to break hyperlinks as possible.
 2020-03-22 16:39:00 +09:00
Takeshi KOMIYA
50cf68e0d4 py domain: Allow to make a style for arguments of functions and methods (refs: #6417) 2020-03-14 16:55:55 +09:00
Takeshi KOMIYA
dd455fe3d3 test: Add testcases for decorators 2020-03-07 23:05:26 +09:00
Takeshi KOMIYA
729efd28b0 py domain: Generate node_id for objects in the right way 2020-03-07 02:00:50 +09:00
Takeshi KOMIYA
5ff3b9dc4d py domain: Generate node_id for modules in the right way 2020-03-07 01:48:17 +09:00
Takeshi KOMIYA
0465c1a7ad Add testcase for modindex_common_prefix 2020-02-29 18:23:58 +09:00
Takeshi KOMIYA
01eff916d1 Fix missing commas after PEP-570 separators 2020-02-24 02:03:15 +09:00
Takeshi KOMIYA
6a439c0bd6
Merge pull request #7155 from tk0miya/function_signature2 
py domain: Use AST parser to convert signature to doctree
 2020-02-22 16:35:59 +09:00
Takeshi KOMIYA
ccd7381d38 test: Use Path.read_text() instead 2020-02-16 20:43:51 +09:00
Takeshi KOMIYA
c4d7f4d6c8 py domain: Use AST parser to convert signature to doctree 2020-02-16 01:52:04 +09:00
Takeshi KOMIYA
ecf7307023
Merge branch '2.0' into 6785_attr_can_refer_props 2020-02-06 22:30:50 +09:00
Takeshi KOMIYA
179a1f9cc2 py domain: Support type annotations for variables 
This adds ``:type:`` and ``:value:`` options to both ``py:data``
and ``py:attribute`` directives.  It allows to describe its
annotation in detail.
 2020-02-01 12:58:27 +09:00
Takeshi KOMIYA
33fcd393ab Fix #6785: py domain: :py:attr: is able to refer properties again 2020-01-25 13:55:27 +09:00
Takeshi KOMIYA
eaf495c3c4 A happy new year! 2020-01-01 14:27:43 +09:00
Takeshi KOMIYA
557d8d140e
Merge pull request #6365 from tk0miya/refactor_py_domain 
Add :abstractmethod: option to py:method directive and support abstractmethod by autodoc
 2019-05-19 23:46:34 +09:00
Takeshi KOMIYA
8ed6a9ceb4 Fix #6379: py domain: Module index (py-modindex.html) has duplicate titles 2019-05-19 22:19:13 +09:00
Takeshi KOMIYA
358e582490 Add :abstractmethod: option to py:method directive (refs: #6138) 2019-05-15 00:00:51 +09:00
Takeshi KOMIYA
a142a654fc Add :property: option to py:method directive 2019-05-12 15:53:39 +09:00
Takeshi KOMIYA
e0abb10792 Fix #4777: Add :async: option to py:function and py:method directives 2019-04-23 01:40:37 +09:00
Takeshi KOMIYA
331594e2ca Add :classmethod: and :staticmethod: options to py:method directive 2019-04-13 23:14:59 +09:00
Takeshi KOMIYA
6af3896103 Add PyFunction and PyVariable; directives for python functions and variables 2019-04-13 20:26:07 +09:00
Takeshi KOMIYA
fcc964b66f Add PyAttribute class; a directive for python attribute description 2019-04-07 22:40:08 +09:00
Takeshi KOMIYA
c8334705ca Add PyClassMethod and PyStaticMethod; directives for python method description 2019-04-07 22:39:27 +09:00
Takeshi KOMIYA
dd6c79476f Add PyMethod class; a directive for python method description 2019-04-07 22:39:27 +09:00
Takeshi KOMIYA
700be75a73 Fix #6196: py domain: unexpected prefix is generated 2019-03-23 22:32:37 +09:00
Takeshi KOMIYA
8980f637c9 Add testcase for sphinx.domains.python 2019-03-23 21:44:00 +09:00
Takeshi KOMIYA
65970a3033 Fix #6140: Use unittest.mock instead of mock 2019-03-09 15:16:04 +09:00
Takeshi KOMIYA
76e9f57c2e Merge branch '1.8' 2019-01-02 16:16:25 +09:00
Takeshi KOMIYA
1b1ebd2c75 A happy new year! 2019-01-02 16:00:30 +09:00
Jon Dufresne
6978918ffc Replace use of six.text_type with str 
This removes the last use of the six package allowing Sphinx to remove
it as a dependency.
 2018-12-18 16:23:10 -08:00
Jon Dufresne
bade33c7e4 Remove unnecessary encoding cookie from Python source files 
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:

https://docs.python.org/3/howto/unicode.html#the-string-type

> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...

Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
 2018-12-16 12:22:12 -08:00
Takeshi KOMIYA
c6bd84a614 refactor: Remove u-prefix from strings 2018-12-16 21:28:51 +09:00
Takeshi KOMIYA
c0fffb9e8b Fix #5432: py domain: :type: field can't process :term: references 2018-09-22 15:24:14 +09:00
Takeshi KOMIYA
f7027049b1 Fix flake8 violations 2018-02-19 23:20:56 +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
Sam Park
7020f6b41d Add tests 2017-07-15 15:18:49 -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
shimizukawa
d497d74370 refs #3458: add sphinx.testing that are moved from /tests directory. 2017-05-14 20:47:15 +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