view roundup/dist/command/build_doc.py @ 4945:55aef7ab35a8

Increase default height of classhelp windows from 400 to 600. If classhelp popup windows are really opened in a separate browser window instead of just a new tab, the window size is often too small, especially when the search frame for finding usernames is displayed. The original size was introduced in 2002 and might have been meant for 640x480 resolutions and the new size might still be too small for many use cases, but this conservative/small increase should not hurt people with small displays.
author Thomas Arendsen Hein <thomas@intevation.de>
date Tue, 25 Nov 2014 16:31:06 +0100
parents 7b575e1f7368
children 7612b86bec69
line wrap: on
line source

#
# Copyright (C) 2009 Stefan Seefeld
# All rights reserved.
# For license terms see the file COPYING.txt.
#

import os, sys
from stat import *
import os.path
from shutil import *
import glob

from distutils.command import build
from distutils.spawn import spawn, find_executable
from distutils.dep_util import newer, newer_group
from distutils.dir_util import copy_tree, remove_tree, mkpath
from distutils.file_util import copy_file
from distutils import sysconfig

class build_doc(build.build):
    """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_temp, 'doc')
        cmd = sphinx + ['-d', temp_dir, 'doc', doc_dir]
        spawn(cmd)

Roundup Issue Tracker: http://roundup-tracker.org/