diff options
| author | Akihiro Motoki <amotoki@gmail.com> | 2017-03-24 23:09:34 +0900 |
|---|---|---|
| committer | Akihiro Motoki <amotoki@gmail.com> | 2017-03-27 05:34:52 +0900 |
| commit | cc04439da40f86c1cacfe7cedfc515598cff1073 (patch) | |
| tree | 3c3f6c3cf98014207d2bc0bce0065dbdbd10cfb4 /setup.cfg | |
| parent | 1a0206d77e0778b776cab4d9baf492eea2588438 (diff) | |
| download | horizon-cc04439da40f86c1cacfe7cedfc515598cff1073.tar.gz | |
Enable warning-on-error in Sphinx 1.5
warning-on-error option is avaialble in sphinx setup command integration
since Sphinx 1.5 [0]. This is useful to prevent future warnings.
Note that there is no sphinx error or warning in the current
horizon code base :)
Also renames 'all_files' to 'all-files' in [build_sphinx] section
as this is the actual option name defined in sphinx [0].
The underscore version 'all_files' also works as pbr
handles it properly, but we use hyphen version for sphinx options,
so the consistent usage is less confusing.
[0] https://github.com/sphinx-doc/sphinx/blob/1.5.3/sphinx/setup_command.py#L69
Change-Id: Ic9d1b0e4db30891c694537d43d7f7a51ff92be49
Diffstat (limited to 'setup.cfg')
| -rw-r--r-- | setup.cfg | 3 |
1 files changed, 2 insertions, 1 deletions
@@ -32,7 +32,8 @@ packages = openstack_dashboard [build_sphinx] -all_files = 1 +all-files = 1 +warning-is-error = 1 build-dir = doc/build source-dir = doc/source |