def _create_source_python_docs():
"""Create a Sphinx project for Source.Python."""
project = SphinxProject(SP_PACKAGES_PATH, SP_DOCS_PATH)
if project.project_exists():
logger.log_message('Sphinx project already exists for Source.Python')
else:
try:
project.create('Source.Python Development Team', 'Source.Python',
VERSION)
except:
logger.log_message('An error occured while creating Sphinx ' +
'project for Source.Python.')
else:
logger.log_message(
'Sphinx project has been created for Source.Python.')
def _create_plugin_docs(package):
"""Create a Sphinx project for a plugin."""
project = SphinxProject(PLUGIN_PATH / package, PLUGIN_DOCS_PATH / package)
if project.project_exists():
logger.log_message('Sphinx project already exists for ' +
'plugin "{0}".'.format(package))
else:
try:
project.create('Unknown')
except:
logger.log_message(
'An error occured while creating Sphinx project ' +
'for plugin "{0}".'.format(package))
else:
logger.log_message('Sphinx project has been created for' +
' plugin "{0}".'.format(package))
def _create_source_python_docs(self):
"""Create a Sphinx project for Source.Python."""
project = SphinxProject(SP_PACKAGES_PATH, SP_DOCS_PATH)
if project.project_exists():
self.logger.log_message(
'Sphinx project already exists for Source.Python')
else:
try:
project.create(
'Source.Python Development Team', 'Source.Python', VERSION)
except:
self.logger.log_message(
'An error occured while creating Sphinx ' +
'project for Source.Python.')
else:
self.logger.log_message(
'Sphinx project has been created for Source.Python.')
def _create_custom_package_docs(package):
"""Create a Sphinx project for a custom package."""
project = SphinxProject(CUSTOM_PACKAGES_PATH / package,
CUSTOM_PACKAGES_DOCS_PATH / package)
if project.project_exists():
logger.log_message('Sphinx project already exists for custom' +
' package "{0}".'.format(package))
else:
try:
project.create('Unknown')
except:
logger.log_message(
'An error occured while creating Sphinx project for ' +
'custom package "{0}".'.format(package))
else:
logger.log_message('Sphinx project has been created for' +
' custom package "{0}".'.format(package))
def _create_plugin_docs(self, package):
"""Create a Sphinx project for a plugin."""
project = SphinxProject(
PLUGIN_PATH / package, PLUGIN_DOCS_PATH / package)
if project.project_exists():
self.logger.log_message(
'Sphinx project already exists for ' +
'plugin "{0}".'.format(package))
else:
try:
project.create('Unknown')
except:
self.logger.log_message(
'An error occured while creating Sphinx project ' +
'for plugin "{0}".'.format(package))
else:
self.logger.log_message(
'Sphinx project has been created for' +
' plugin "{0}".'.format(package))
def _create_custom_package_docs(self, package):
"""Create a Sphinx project for a custom package."""
project = SphinxProject(
CUSTOM_PACKAGES_PATH / package,
CUSTOM_PACKAGES_DOCS_PATH / package)
if project.project_exists():
self.logger.log_message(
'Sphinx project already exists for custom' +
' package "{0}".'.format(package))
else:
try:
project.create('Unknown')
except:
self.logger.log_message(
'An error occured while creating Sphinx project for ' +
'custom package "{0}".'.format(package))
else:
self.logger.log_message(
'Sphinx project has been created for' +
' custom package "{0}".'.format(package))
