Commit Graph

13176 Commits

Author SHA1 Message Date
Takeshi KOMIYA
16acc15b2c
Merge pull request #6386 from tk0miya/doclinter
Enable doclinter by default on CI
2019-05-26 11:03:37 +09:00
Takeshi KOMIYA
4bb1a56842 Do docslint on Travis 2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
9b2423c5bb doclinter: restrict by 90 columns 2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
439f329466 doclinter: Fix files are ignored. 2019-05-26 10:53:52 +09:00
Takeshi KOMIYA
c4b20a82ea doclinter: Ignore large code-block and long interpreted text 2019-05-26 10:53:52 +09:00
Takeshi KOMIYA
ce9d58349e refactor: Add AutosummaryRenderer; rendering utility for autosummary 2019-05-26 00:52:10 +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
dd1b5beb74 Fix #6350: autosummary is confused by an argument having namedtuple as a default value 2019-05-25 21:25:07 +09:00
Takeshi KOMIYA
5d640f3c10 Fix #6350: autosummary is confused by an argument having default string value containing a single quote 2019-05-25 21:25:07 +09:00
Takeshi KOMIYA
4b86215fbf Fix #6387: html search: failed to search document with haiku and scrolls themes 2019-05-25 21:21:44 +09:00
Takeshi KOMIYA
6e795a05be
Merge pull request #6388 from tk0miya/6325_autodoc_supports_slots
Close #6325: autodoc: Support attributes in __slots__
2019-05-25 21:17:04 +09:00
jfbu
fea3e639da Update CHANGES for PR #6364 2019-05-24 17:05:53 +02:00
Jean-François B
96da68d948
Merge pull request #6364 from wallento/fix-latex-figure-in-admonition
Fix latex figure in admonition
2019-05-24 16:56:09 +02:00
Stefan Wallentowitz
ac0bb5132b Fix latex figure in admonition
Using figures in an admonition produces a LaTeX error ("Not in outer
par mode."). This is because it generates a float in a float. This can
be trivially fixed by overwriting the alignment to H, which is also
what is most probably intended.
2019-05-24 16:07:13 +02: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
277aba935d Close #6325: autodoc: Support attributes in __slots__ 2019-05-22 09:56:46 +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