1# Copyright 2015-2016 Christoph Reiter
2#
3# Permission is hereby granted, free of charge, to any person obtaining
4# a copy of this software and associated documentation files (the
5# "Software"), to deal in the Software without restriction, including
6# without limitation the rights to use, copy, modify, merge, publish,
7# distribute, sublicense, and/or sell copies of the Software, and to
8# permit persons to whom the Software is furnished to do so, subject to
9# the following conditions:
10#
11# The above copyright notice and this permission notice shall be included
12# in all copies or substantial portions of the Software.
13#
14# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22import os
23import sys
24
25from .util import Command
26
27
28class build_sphinx(Command):
29    description = "build sphinx documentation"
30    user_options = [
31        ("build-dir=", "d", "build directory"),
32        ("all", "a", "build all docs, not just the user guide"),
33    ]
34
35    def initialize_options(self):
36        self.build_dir = None
37        self.all = False
38
39    def finalize_options(self):
40        self.build_dir = self.build_dir or "build"
41        self.all = bool(self.all)
42
43    def run(self):
44        DOCS_ROOT = "docs"
45        GUIDE_ROOT = os.path.join(DOCS_ROOT, "guide")
46        TARGET = os.path.join(self.build_dir, "sphinx")
47
48        srcdir = GUIDE_ROOT if not self.all else DOCS_ROOT
49        self.spawn([sys.executable, "-m", "sphinx",
50                    "-b", "html", "-c", DOCS_ROOT,
51                    "-n", "-E", srcdir, TARGET])
52