Commit Graph

423 Commits

Author SHA1 Message Date
Takeshi KOMIYA
2afba22cee Merge pull request #6397 from tk0miya/6361_autodoc_typehints
Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature
2019-06-01 01:07:37 +09:00
gilch
e7239053b7 Grammar corrections 2019-05-29 19:41:45 -06:00
Takeshi KOMIYA
d6063ff35b doc: Fold lines by 80 columns 2019-05-30 01:07:05 +09:00
Takeshi KOMIYA
b9d7239d90 Merge branch '2.0' 2019-05-29 00:51:25 +09:00
Takeshi KOMIYA
9b2423c5bb doclinter: restrict by 90 columns 2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
0ea380eddd Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature 2019-05-26 00:35:24 +09:00
Takeshi KOMIYA
3105feec80 doc: Update with rst:directive:option directive 2019-05-20 00:26:28 +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
woutdenolf
1a67b87910 Merge branch 'master' into feature-autosummary-packages 2019-05-18 14:42:34 +02:00
Takeshi KOMIYA
279223065b Merge branch '2.0' into master 2019-05-17 01:24:45 +09:00
Gibson Fahnestock
6f7cb4da94 autosectionlabel: add type for suppress_warnings
This sets the subtype to the filename, which means that you can suppress
warnings for individual paths.

For example for the following warning:

```
path/to/file.rst:5547: WARNING: duplicate label path/to/file:label, other instance in /path/to/file.rst
```

You would add this to `config.py` to suppress all warnings:

```python
extensions = [
    'sphinx.ext.autosectionlabel',
]

autosectionlabel_prefix_document = True

suppress_warnings = [
    'autosectionlabel.*',
]
```

To suppress warnings for the individual file path you would do:

```python
suppress_warnings = [
    'autosectionlabel.path/to/file',
]
```

Fixes: https://github.com/sphinx-doc/sphinx/issues/6371
2019-05-15 19:30:46 +01:00
Adrián Chaves
e84ba7f78a Support coverage_ignore_pyobjects in the coverage builder 2019-05-15 12:23:05 +02:00
Takeshi KOMIYA
64eacb30a8 Fix modname of HTMLHelpBuilder 2019-05-15 00:08:27 +09:00
Takeshi KOMIYA
358e582490 Add :abstractmethod: option to py:method directive (refs: #6138) 2019-05-15 00:00:51 +09:00
Takeshi KOMIYA
f63abac2ca Merge branch '2.0' 2019-05-13 22:03:26 +09:00
Takeshi KOMIYA
416426dfb7 Merge pull request #6356 from tk0miya/foldlines
Add utils/doclinter.py; a documenter linter for Sphinx
2019-05-13 14:39:01 +09:00
Takeshi KOMIYA
ca605c7437 Add :type: option for rst:directive:option directive 2019-05-13 14:14:14 +09:00
Takeshi KOMIYA
4307dec3ac Add rst:directive:option directive 2019-05-13 13:55:56 +09:00
Takeshi KOMIYA
fa00458f4f docs: Fold lines by 80 chars 2019-05-12 17:57:38 +09:00
Takeshi KOMIYA
a142a654fc Add :property: option to py:method directive 2019-05-12 15:53:39 +09:00
Takeshi KOMIYA
37a5736a1f Merge branch '2.0' 2019-05-06 21:09:43 +09:00
jfbu
48ad83d061 Reorganize documentation of the imgmath configuration variables 2019-04-24 12:30:18 +02:00
jfbu
ea28bd9fb0 More robust code for getting saved "depth" of svg inline math snippet 2019-04-24 11:56:19 +02:00
jfbu
3edcff7952 Make imgmath_use_preview work also for svg output 2019-04-23 15:13:21 +02: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
a285220778 Merge branch '2.0' into refactor_py_domain2 2019-04-23 01:16:42 +09:00
jfbu
6009140f22 Fix a dvisvgm link in docs and add preview-latex link 2019-04-17 10:07:30 +02:00
Alex Sergeev
98691baf85 Address comments 2019-04-14 10:47:50 -10:00
Alex Sergeev
4bad5bd419 Address feedback 2019-04-13 20:54:20 -10:00
Takeshi KOMIYA
331594e2ca Add :classmethod: and :staticmethod: options to py:method directive 2019-04-13 23:14:59 +09:00
jfbu
9ecd42574d Documentation of smartquotes_excludes (and smartquotes_action) 2019-04-12 18:34:10 +02:00
woutdenolf
6e0b0517c0 [autosummary] address code review 2019-04-07 12:00:57 +02:00
woutdenolf
4004dd5635 Merge branch 'master' into feature-autosummary-packages 2019-04-07 10:32:57 +02:00
Takeshi KOMIYA
338941a49a Fix #6213: ifconfig: contents after headings are not shown 2019-04-05 02:34:23 +09:00
Takeshi KOMIYA
005913630f Add missing versionadded for autosummary_mock_imports 2019-04-04 23:49:43 +09:00
Takeshi KOMIYA
6cb263b9c8 Merge pull request #6212 from tsanikgr/feature/autosummary_imported_members
Allow setting imported_members for autosummary in conf.py
2019-04-04 23:04:36 +09:00
tsanikgr
eb03b1406f Simplify docs 2019-04-03 17:31:16 +01:00
Takeshi KOMIYA
a6ef53083c Merge pull request #6215 from rkdarst/mathjax-doc-clarification
Clarify MathJax extension usage
2019-03-30 00:52:39 +09:00
Richard Darst
277588f2f9 Clarify MathJax extension usage: edits from review 2019-03-29 16:40:18 +02:00
Richard Darst
dd0246c6dc Clarify MathJax extension usage
- We recently hit an issue where we expected the MathJax extension to
  work with the default MathJax markup.  Obviously that shouldn't be
  the case (since then other formats couldn't use the math), but it
  can't hurt to include a hint.
- Link from the math HTML extension page to the relevant
  roles/directives.
- Also make it explicit that MathJax has a default, and that it's an
  external resource that will be dynamically linked.
2019-03-27 18:10:09 +02:00
tsanikgr
bec116a3b6 #5877: Allow setting imported_members for autosummary in conf.py 2019-03-27 14:19:16 +00:00
Michael Goerz
4e27cc465a Fix docs of inheritance-diagram "parts" option
The documentation now correctly describes the behavior of the ``parts``
option in an inheritance-diagram directive: it gives the number of parts
that are *kept* not dropped. The option now also accepts negative
values, which drops parts from the left (which is the what the
documentation incorrectly claimed the option would do for positive
values)

As a form of testing of the new functionality, the documentation for the
inheritance_diagram extension now includes a section "Examples" that
demonstrate the different possibilities. This would fail to build
without the patch.

Closes #4872
2019-03-19 01:19:29 +09:00
Michael Goerz
1f136215c1 Fix docs of inheritance-diagram "parts" option
The documentation now correctly describes the behavior of the ``parts``
option in an inheritance-diagram directive: it gives the number of parts
that are *kept* not dropped. The option now also accepts negative
values, which drops parts from the left (which is the what the
documentation incorrectly claimed the option would do for positive
values)

As a form of testing of the new functionality, the documentation for the
inheritance_diagram extension now includes a section "Examples" that
demonstrate the different possibilities. This would fail to build
without the patch.

Closes #4872
2019-03-10 18:37:05 -04:00
Antony Lee
386ec9cd9a Fix doc typo. 2019-03-07 14:17:41 +01:00
Takeshi KOMIYA
ba86f4ea78 Merge branch '2.0' 2019-03-07 01:23:26 +09:00
Takeshi KOMIYA
10869289ef docs: JS domain does not support reset current module 2019-03-03 14:56:38 +09:00
Takeshi KOMIYA
01f46111c5 Merge branch '2.0' 2019-03-02 18:38:24 +09:00
Takeshi KOMIYA
ceef713e79 docs: Remove a term "new" from config values 2019-02-27 01:18:57 +09:00
Takeshi KOMIYA
51db9358fc Merge pull request #6048 from stephenfin/doc-rework-tutorials
Doc rework (development guide, part 1)
2019-02-26 22:51:55 +09:00
woutdenolf
33e7b76c32 Merge branch 'master' into feature-autosummary-packages 2019-02-24 12:16:52 +01:00