blob: 58c6d97371791320cf6ba336dffc28f097616f82 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
# coding=utf-8
"""
Test the build of the sphinx documentation
Released under MIT license, see LICENSE file
"""
import os
import pytest
from sphinx.application import Sphinx
DOCS_SRCDIR = 'docs'
DOCS_BUILDDIR = os.path.join('docs', '_build')
DOCS_TREEDIR = os.path.join(DOCS_BUILDDIR, 'doctrees')
def test_html_documentation():
# if you want really strict checking, set warningiserror=True
docs = Sphinx(DOCS_SRCDIR,
DOCS_SRCDIR,
DOCS_BUILDDIR,
DOCS_TREEDIR,
buildername='html',
warningiserror=False,
)
# this throws exceptions for errors, which pytest then
# treats as a failure
docs.build(force_all=True)
|
