diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-01-04 23:10:41 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-01-04 23:10:41 +0900 |
| commit | 7a76e8582eb94c90e9d5a7137f9e84e8c563db7a (patch) | |
| tree | 99319ecb2686588affb0459e0df218edcfe9c886 /doc/source/config.rst | |
| parent | f54fe9a5ba3f7f4d6c9f05e57bca8095e7368853 (diff) | |
| download | buildstream-gating-on-docs-breakage.tar.gz | |
Documentation: Fix warnings, and make all warnings errors.gating-on-docs-breakage
Some of the warnings from sphinx-build are really just warnings,
but a lot of the things we want to avoid and really break documentation,
like broken internal references and some invalid rst directives should
really be errors.
Now we treat all warnings as errors, this should ensure that
any commits landing upstream never break the docs.
Diffstat (limited to 'doc/source/config.rst')
| -rw-r--r-- | doc/source/config.rst | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/source/config.rst b/doc/source/config.rst index 2b9883f93..a5ceb8762 100644 --- a/doc/source/config.rst +++ b/doc/source/config.rst @@ -1,3 +1,5 @@ +:orphan: + .. _config: |