Mercurial > p > roundup > code
view roundup/dist/command/build_doc.py @ 7698:4e37a7833708
doc: add FTS5 requirement for sqlite backend.
Document the requirement for FTS5 if you are using the sqlite backend.
Tonu Mikk reported issues with using a SQLite that was missing FTS5
support (RedHat 7 sqlite with python 3.6). Even though FTS5 has been
in the sqlite amalgamation since 2015-10-14 (v3.9.0) RedHat chose to
not build their package with that. This leads to a traceback when
initializing the database.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sat, 11 Nov 2023 19:39:57 -0500 |
| parents | d2ca7b1bfc6b |
| children |
line wrap: on
line source
# # Copyright (C) 2009 Stefan Seefeld # All rights reserved. # For license terms see the file COPYING.txt. # import os, sys import os.path try: from setuptools.command.install import install as _build_py except ImportError: from distutils.command.build import build as _build_py # try/except clause orig_build = _build_py try: # would be nice to use setuptools.Command.spawn() as it # obeys the dry-run flag. from subprocess import run as spawn except ImportError: from distutils.spawn import spawn # try/except: in except for subprocess try: from distutils.spawn import find_executable # try/except: in try local find except ImportError: from roundup.dist.command import find_executable class build_doc(_build_py): """Defines the specific procedure to build roundup's documentation.""" description = "build documentation" def run(self): """Run this command, i.e. do the actual document generation.""" sphinx = find_executable('sphinx-build') if sphinx: sphinx = [sphinx] else: try: # try to find version installed with Python tools # tested with Sphinx 1.1.3 import sphinx as sp except ImportError: pass else: sphinx = [sys.executable, sp.__file__] if not sphinx: self.warn("could not find sphinx-build in PATH") self.warn("cannot build documentation") return doc_dir = os.path.join('share', 'doc', 'roundup', 'html') temp_dir = os.path.join(self.build_base, 'temp.doc') cmd = sphinx + ['-d', temp_dir, 'doc', doc_dir] spawn(cmd)
