Commit Graph

13100 Commits

Author SHA1 Message Date
Takeshi KOMIYA
be6f4fd8f6 refactor apidoc: Add is_skipped_module() 2019-05-30 01:12:23 +09:00
Takeshi KOMIYA
38aacdffdb
Merge pull request #6392 from tk0miya/6348_hieroglyph
doc: Remove hieroglyph temporarily (refs: #6348)
2019-05-23 10:54:28 +09:00
Takeshi KOMIYA
1e221da332 doc: Remove hieroglyph temporarily (refs: #6348) 2019-05-23 10:32:18 +09:00
Takeshi KOMIYA
12ad21f1e3
Merge pull request #6385 from tk0miya/6384_docs
docs: Update URL of writethedocs (refs: #6384)
2019-05-21 23:15:00 +09:00
Takeshi KOMIYA
44f03e2c75 docs: Update URL of writethedocs 2019-05-21 22:16:15 +09:00
Takeshi KOMIYA
3de408d2d9
Merge pull request #6366 from tk0miya/refactor_rst_domain_doc
doc: Update with rst:directive:option directive
2019-05-20 01:33:41 +09:00
Takeshi KOMIYA
c749eb1ba6 Make directive option unique using directive name 2019-05-20 00:59:18 +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
Takeshi KOMIYA
603bae4173
Merge pull request #6376 from tk0miya/6375_angle_brackets_in_linktitle
Fix #6375: extlinks: Cannot escape angle brackets in link caption
2019-05-19 23:43:50 +09:00
Takeshi KOMIYA
220dbfe6cf
Merge pull request #6383 from tk0miya/6379_dup_modindex
Fix #6379: py domain: Module index (py-modindex.html) has duplicate titles
2019-05-19 23:43:09 +09:00
Takeshi KOMIYA
1be3f6c653
Merge branch '2.0' into 6375_angle_brackets_in_linktitle 2019-05-19 23:28:05 +09:00
Takeshi KOMIYA
d854ec9e10
Merge pull request #6381 from tk0miya/6378_linkcheck
Fix #6378: linkcheck: Send commonly used User-Agent
2019-05-19 23:25:56 +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
690a566791 Fix #6378: linkcheck: Send commonly used User-Agent 2019-05-19 01:39:05 +09:00
Takeshi KOMIYA
4fc121fb99 Update CHANGES 2019-05-17 01:55:08 +09:00
Takeshi KOMIYA
f0fe536535
Merge pull request #6209 from Gallaecio/master
Support coverage_ignore_py in the coverage extension
2019-05-17 01:53:07 +09:00
Takeshi KOMIYA
63b30b1779
Merge pull request #6270 from larsoner/explain
ENH: Explain warnings-as-errors
2019-05-17 01:25:35 +09:00
Takeshi KOMIYA
279223065b
Merge branch '2.0' into master 2019-05-17 01:24:45 +09:00
Takeshi KOMIYA
2965f2cdc5
Merge pull request #6373 from gibfahn/suppress_warnings_autosectionlabel
autosectionlabel: add type for suppress_warnings
2019-05-17 01:15:34 +09:00
Takeshi KOMIYA
092d87bde9 Fix #6375: extlinks: Cannot escape angle brackets in link caption 2019-05-16 23:14:57 +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
Eric Larson
926e0e766d ENH: Explain warnings-as-errors 2019-05-14 14:32:11 -04: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
048fd3d09c
Merge pull request #6368 from tk0miya/refactor_autodoc
Reduce warnings of autodoc in 2.0 branch
2019-05-15 00:35:25 +09:00
Takeshi KOMIYA
45ebbc6e86
Merge pull request #6367 from tk0miya/refactor_docs
Fix modname of HTMLHelpBuilder
2019-05-15 00:34:18 +09:00
Takeshi KOMIYA
7c8b1ad900 refactor: apidoc: Replace makename() by module_join() 2019-05-15 00:18:00 +09:00
Takeshi KOMIYA
0489fad63a Do not emit warning for Documenter.format_args() 2019-05-15 00:10:00 +09:00
Takeshi KOMIYA
db4dd6c9f9 Fix FakeDirective emits warnings 2019-05-15 00:09:58 +09:00
Takeshi KOMIYA
64eacb30a8 Fix modname of HTMLHelpBuilder 2019-05-15 00:08:27 +09:00
Takeshi KOMIYA
e288999933 Close #744: autodoc: Support abstractmethod 2019-05-15 00:01:00 +09:00
Takeshi KOMIYA
358e582490 Add :abstractmethod: option to py:method directive (refs: #6138) 2019-05-15 00:00:51 +09:00
Takeshi KOMIYA
af9df449ea Update CHANGES for PR #6358 2019-05-14 22:32:05 +09:00
Takeshi KOMIYA
c1b30c1204
Merge pull request #6358 from cpitclaudel/production_rawsource
productionlist: Put the full production in production.rawsource
2019-05-14 22:30:38 +09:00
Clément Pit-Claudel
44c8a3b982 productionlist: Put the full production in production.rawsource
This makes it possible to iterate over the productions and see exactly the text
that was entered by the author, which is useful to e.g. extract information from
the grammar (like syntax-highlighting patterns).
2019-05-13 23:21:55 -04:00
Takeshi KOMIYA
55554b0ead Update CHANGES for PR #6363 2019-05-13 23:59:23 +09:00
Takeshi KOMIYA
6e32bb7042
Merge pull request #6363 from bskinn/6323_makebat_o_opt
Add %O% option to make.bat template; update docs
2019-05-13 23:57:38 +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
774c59821c
Merge pull request #6353 from tk0miya/6311_autosummary_confused_by_complex_typehints2
Fix #6311: autosummary: autosummary table gets confused by complex type hints
2019-05-13 21:51:11 +09:00
Takeshi KOMIYA
59d0f076ec
Merge branch '2.0' into 6311_autosummary_confused_by_complex_typehints2 2019-05-13 21:16:43 +09:00
jfbu
3e5adaa225 Update CHANGES for #6303 2019-05-13 15:03:53 +09:00
jfbu
7cc1ebd28e Partially revert #6232, synchronize new Makefile with old (refs: #4092) 2019-05-13 15:00:32 +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
27a9a3b678
Merge pull request #6359 from tk0miya/refactor_py_domain
refactor get_members() in autosummary
2019-05-13 14:37:03 +09:00
Takeshi KOMIYA
8df362154e
Merge pull request #6314 from tk0miya/refactor_rst_domain3
Add rst:directive:option directive
2019-05-13 14:29:32 +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
743607d497 refactor get_members() in autosummary 2019-05-13 13:53:10 +09:00
Takeshi KOMIYA
e32a610d7a
Merge pull request #6320 from tk0miya/refactor_py_domain3
Support property (autodoc, py-domain)
2019-05-13 13:49:15 +09:00