def finalize_options(self):
# We need to make sure this is set before finalize_options otherwise
# the default is set to build/sphinx. We also need the absolute path
# as in some Sphinx versions, the path is otherwise interpreted as
# docs/docs/_build.
if self.build_dir is None:
self.build_dir = os.path.abspath('docs/_build')
else:
self.build_dir = os.path.abspath(self.build_dir)
SphinxBuildDoc.finalize_options(self)
# Clear out previous sphinx builds, if requested
if self.clean_docs:
dirstorm = [
os.path.join(self.source_dir, 'api'),
os.path.join(self.source_dir, 'generated')
]
if self.build_dir is None:
dirstorm.append('docs/_build')
else:
dirstorm.append(self.build_dir)
for d in dirstorm:
if os.path.isdir(d):
log.info('Cleaning directory ' + d)
shutil.rmtree(d)
else:
log.info('Not cleaning directory ' + d + ' because '
'not present or not a directory')
def finalize_options(self):
# This has to happen before we call the parent class's finalize_options
if self.build_dir is None:
self.build_dir = 'docs/_build'
SphinxBuildDoc.finalize_options(self)
# Clear out previous sphinx builds, if requested
if self.clean_docs:
dirstorm = [
os.path.join(self.source_dir, 'api'),
os.path.join(self.source_dir, 'generated')
]
dirstorm.append(self.build_dir)
for d in dirstorm:
if os.path.isdir(d):
log.info('Cleaning directory ' + d)
shutil.rmtree(d)
else:
log.info('Not cleaning directory ' + d + ' because '
'not present or not a directory')
def finalize_options(self):
# Clear out previous sphinx builds, if requested
if self.clean_docs:
dirstorm = [os.path.join(self.source_dir, "api")]
if self.build_dir is None:
dirstorm.append("docs/_build")
else:
dirstorm.append(self.build_dir)
for d in dirstorm:
if os.path.isdir(d):
log.info("Cleaning directory " + d)
shutil.rmtree(d)
else:
log.info("Not cleaning directory " + d + " because " "not present or not a directory")
SphinxBuildDoc.finalize_options(self)
def finalize_options(self):
#Clear out previous sphinx builds, if requested
if self.clean_docs:
dirstorm = [os.path.join(self.source_dir, 'api')]
if self.build_dir is None:
dirstorm.append('docs/_build')
else:
dirstorm.append(self.build_dir)
for d in dirstorm:
if os.path.isdir(d):
log.info('Cleaning directory ' + d)
shutil.rmtree(d)
else:
log.info('Not cleaning directory ' + d + ' because '
'not present or not a directory')
SphinxBuildDoc.finalize_options(self)
def finalize_options(self):
from os.path import isfile
from distutils.cmd import DistutilsOptionError
if self.build_dir is not None:
if isfile(self.build_dir):
raise DistutilsOptionError('Attempted to build_sphinx into a file '+self.build_dir)
self.mkpath(self.build_dir)
return BuildDoc.finalize_options(self)
def finalize_options(self):
# Clear out previous sphinx builds, if requested
if self.clean_docs:
dirstorm = [os.path.join(self.source_dir, 'api'),
os.path.join(self.source_dir, 'generated')]
if self.build_dir is None:
dirstorm.append('docs/_build')
else:
dirstorm.append(self.build_dir)
for d in dirstorm:
if os.path.isdir(d):
log.info('Cleaning directory ' + d)
shutil.rmtree(d)
else:
log.info('Not cleaning directory ' + d + ' because '
'not present or not a directory')
SphinxBuildDoc.finalize_options(self)
def finalize_options(self):
from os.path import isdir
from shutil import rmtree
# Clear out previous sphinx builds, if requested
if self.clean_docs:
dirstorm = ["docs/_generated"]
if self.build_dir is None:
dirstorm.append("docs/_build")
else:
dirstorm.append(self.build_dir)
for d in dirstorm:
if isdir(d):
log.info("Cleaning directory " + d)
rmtree(d)
else:
log.info("Not cleaning directory " + d + " because " "not present or not a directory")
BuildDoc.finalize_options(self)
def finalize_options(self):
from os.path import isdir
from shutil import rmtree
#Clear out previous sphinx builds, if requested
if self.clean_docs:
dirstorm = ['docs/_generated']
if self.build_dir is None:
dirstorm.append('docs/_build')
else:
dirstorm.append(self.build_dir)
for d in dirstorm:
if isdir(d):
log.info('Cleaning directory ' + d)
rmtree(d)
else:
log.info('Not cleaning directory ' + d + ' because '
'not present or not a directory')
SphinxBuildDoc.finalize_options(self)
class build_doc(Command):
description = 'Builds the documentation'
user_options = []
def __init__(self, dist):
self.epydoc = EpydocBuildDoc(dist)
self.sphinx = None
try:
from sphinx.setup_command import BuildDoc as SphinxBuildDoc
self.sphinx = SphinxBuildDoc(dist)
except ImportError:
print('sphinx not installed, skipping user documentation')
Command.__init__(self, dist)
def initialize_options(self):
if self.sphinx:
self.sphinx.initialize_options()
self.epydoc.initialize_options()
def finalize_options(self):
build = self.get_finalized_command('build')
d1 = os.path.join(build.build_base, 'homepage', 'doc', 'api')
self.mkpath(d1)
if self.sphinx:
self.sphinx.build_dir = os.path.join(build.build_base, 'homepage',
'doc')
self.sphinx.finalize_options()
self.epydoc.finalize_options()
def run(self):
self.epydoc.run()
if self.sphinx:
self.sphinx.run()
# fixme
os.system('cp -r doc/homepage build')
def finalize_options(self):
from os.path import split,join
from distutils.cmd import DistutilsOptionError
if self.build_dir is not None:
# the _static dir should be in the same place as the _build dir
# for Astropy
basedir,subdir = split(self.build_dir)
if subdir=='': #the path has a trailing /...
basedir,subdir = split(basedir)
staticdir = join(basedir,'_static')
if os.path.isfile(staticdir):
raise DistutilsOptionError(
'Attempted to build_sphinx such in a location where' +
staticdir + 'is a file. Must be a directory.')
self.mkpath(staticdir)
return BuildDoc.finalize_options(self)
def finalize_options(self):
BuildDoc.finalize_options(self)
def finalize_options(self):
""" Override the default for the documentation build
directory.
"""
self.build_dir = os.path.join(*DOC_BUILD_DIR.split(os.sep)[:-1])
BuildDoc.finalize_options(self)
def finalize_options(self):
""" Override the default for the documentation build
directory.
"""
self.build_dir = os.path.join(*DOC_BUILD_DIR.split(os.sep)[:-1])
BuildDoc.finalize_options(self)
def finalize_options(self):
BuildDoc.finalize_options(self)
