sphinx/doc/usage
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
..
advanced doc: Add "websupport" to usage guide 2018-11-16 13:23:06 +01:00
builders Fix modname of HTMLHelpBuilder 2019-05-15 00:08:27 +09:00
extensions Address comments 2019-04-14 10:47:50 -10:00
restructuredtext Merge pull request #6356 from tk0miya/foldlines 2019-05-13 14:39:01 +09:00
configuration.rst autosectionlabel: add type for suppress_warnings 2019-05-15 19:30:46 +01:00
installation.rst Remove instructions to install Python 2 on Windows 2018-12-23 04:00:26 -08:00
markdown.rst Update Markdown doc (#5913) 2019-01-09 16:44:00 +01:00
quickstart.rst Capitalize the Internet 2018-12-29 18:54:06 +01:00
theming.rst doc: Add "theming" to usage guide 2018-11-16 15:23:33 +01:00