Commit Graph
2440 Commits
Author SHA1 Message Date
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 c81ae00430 Merge pull request #6369 from tk0miya/refactor_apidoc_module_join
refactor: apidoc: Replace makename() by module_join()
2019-05-15 00:36:21 +09:00
Takeshi KOMIYA 7c8b1ad900 refactor: apidoc: Replace makename() by module_join() 2019-05-15 00:18:00 +09:00
Takeshi KOMIYA 64eacb30a8 Fix modname of HTMLHelpBuilder 2019-05-15 00:08:27 +09:00
Brian Skinn 0dbdae3159 Add %O% option to make.bat templates; update docs
The make.bat_t and make.bat.new_t templates now pass %O% as well as
%SPHINXOPTS% to `sphinx-build`, in parity with Makefile.new_t.

The sphinx-build documentation page was updated to explicitly note
$(O) and %O% as shortcut variables.

Closes #6323, per the comment thread discussion.
2019-05-13 10:44:27 -04: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 fa560ebf95 apidoc: Deprecate unused functions 2019-05-04 18:42:22 +09:00
Jon Dufresne ee23a29b3c Deprecate EpubBuilder.esc() in favor of stdlib html.escape()
Available since Python 3.2.

https://docs.python.org/3/library/html.html#html.escape
2019-04-23 19:34:55 -07: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
Takeshi KOMIYA e9e8fd264b Merge pull request #6308 from tk0miya/imgmath_template
imgmath: Use template file for LaTeX
2019-04-19 13:13:37 +09:00
Takeshi KOMIYA 06f86b0639 Make EventManager portable
So far, we need to bypass application object for modules to emit
a event.  This make EventManager portable and easy to pass event
emitter.  This brings modules less coupled with application object.
2019-04-16 14:06:36 +09:00
Takeshi KOMIYA aabeb71123 imgmath: Use template file for LaTeX 2019-04-16 01:38:31 +09: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
Takeshi KOMIYA 6af3896103 Add PyFunction and PyVariable; directives for python functions and variables 2019-04-13 20:26:07 +09:00
Takeshi KOMIYA b0b3f5a677 deprecate PyClassmember class 2019-04-07 22:41:10 +09:00
Takeshi KOMIYA c840cb744c Merge branch '2.0' into refactor_citations 2019-04-06 14:23:04 +09:00
Takeshi KOMIYA 452e5dcf21 Deprecate StandardDomain.process_*() 2019-04-06 14:14:18 +09: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 885d35e374 Add CitationDomain for citation processing 2019-03-30 23:12:08 +09:00
Takeshi KOMIYA 87c6335b46 Move transforms for citations to sphinx.domains.citation 2019-03-30 20:31:10 +09: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
Takeshi KOMIYA a990f9ff72 Add ObjectDescription.get_field_type_map()
Conceal caching mechanism of Field classes to ObjectDescription class.
This deprecates DocFieldTransformer.preprocess_field_types().
2019-03-23 17:27:22 +09: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
Takeshi KOMIYA e6cc18cc59 Merge pull request #6164 from goerz/inheritance_diagram
Fix docs of inheritance-diagram "parts" option
2019-03-19 01:18:07 +09:00
Jon Dufresne 22afc77c48 Python-3-only clean ups discovered by pyupgrade
https://github.com/asottile/pyupgrade

> A tool to automatically upgrade syntax for newer versions of the
> language.

- Drop u str prefix
- Drop base object inheritance
- Drop args to super()
- Use set literals
- Use dict comprehension
- Use set comprehension
2019-03-19 01:09:48 +09:00
Jon Dufresne f210475489 Python-3-only clean ups discovered by pyupgrade
https://github.com/asottile/pyupgrade

> A tool to automatically upgrade syntax for newer versions of the
> language.

- Drop u str prefix
- Drop base object inheritance
- Drop args to super()
- Use set literals
- Use dict comprehension
- Use set comprehension
2019-03-17 12:58:03 -07:00
Takeshi KOMIYA 86d5d2113e Deprecate imports for compatibility 2019-03-17 18:30:50 +09:00
Takeshi KOMIYA b5959ca230 Add SphinxPostTransform class (#6154)
* Add SphinxPostTransform

* Apply SphinxPostTransform to latex transforms
2019-03-17 18:27:00 +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
Takeshi KOMIYA 2606002bb4 Merge pull request #6125 from tk0miya/doc-enhance_extension_dev_i18n
doc: Enhance documentation about internalization of external extension (refs: #5991)
2019-03-10 01:16:06 +09:00
Jakob Lykke Andersen 59b6a5e622 Merge pull request #6142 from anntzer/doctypo
Fix doc typo.
2019-03-09 11:51:24 +01:00
Takeshi KOMIYA d4ac7217a8 Move list of deprecated API to extdev/deprecated.rst 2019-03-09 19:32:24 +09: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 4ca5924d49 Merge pull request #6129 from tk0miya/refactor_util.nodes
Refactor util.nodes
2019-03-07 01:20:06 +09:00