def _generate_plugin_docs(package):
"""Generate Sphinx project files for a plugin."""
project = SphinxProject(PLUGIN_PATH / package, PLUGIN_DOCS_PATH / package)
if project.project_exists():
try:
project.generate_project_files()
except:
logger.log_message('An error occured while generating project ' +
'files for plugin "{0}".'.format(package))
else:
logger.log_message('Project files have been generated ' +
'for plugin "{0}".'.format(package))
else:
logger.log_message('Sphinx project does not exist for' +
' plugin "{0}".'.format(package))
def _generate_custom_package_docs(package):
"""Generate Sphinx project files for a custom package."""
project = SphinxProject(CUSTOM_PACKAGES_PATH / package,
CUSTOM_PACKAGES_DOCS_PATH / package)
if project.project_exists():
try:
project.generate_project_files()
except:
logger.log_message(
'An error occured while generating project ' +
'files for custom package "{0}".'.format(package))
else:
logger.log_message('Project files have been generated for '
'custom package "{0}".'.format(package))
else:
logger.log_message('Sphinx project does not exist for ' +
'custom package "{0}".'.format(package))
def _generate_plugin_docs(self, package):
"""Generate Sphinx project files for a plugin."""
project = SphinxProject(
PLUGIN_PATH / package, PLUGIN_DOCS_PATH / package)
if project.project_exists():
try:
project.generate_project_files()
except:
self.logger.log_message(
'An error occured while generating project ' +
'files for plugin "{0}".'.format(package))
else:
self.logger.log_message(
'Project files have been generated ' +
'for plugin "{0}".'.format(package))
else:
self.logger.log_message(
'Sphinx project does not exist for' +
' plugin "{0}".'.format(package))
def _generate_source_python_docs():
"""Generate Sphinx project files for Source.Python."""
project = SphinxProject(SP_PACKAGES_PATH, SP_DOCS_PATH)
if project.project_exists():
try:
project.generate_project_files('developing/modules')
except:
logger.log_message('An error occured while generating ' +
'project files for Source.Python')
else:
modules_dir = project.project_source_dir / 'developing' / 'modules'
modules_dir.joinpath('modules.rst').remove()
for file_path in modules_dir.files('source-python.*.rst'):
_prepare_generated_source_python_file(file_path)
logger.log_message(
'Project files have been generated for Source.Python.')
else:
logger.log_message('Sphinx project does not exist for Source.Python.')
def _generate_custom_package_docs(self, package):
"""Generate Sphinx project files for a custom package."""
project = SphinxProject(
CUSTOM_PACKAGES_PATH / package,
CUSTOM_PACKAGES_DOCS_PATH / package)
if project.project_exists():
try:
project.generate_project_files()
except:
self.logger.log_message(
'An error occured while generating project ' +
'files for custom package "{0}".'.format(package))
else:
self.logger.log_message(
'Project files have been generated for '
'custom package "{0}".'.format(package))
else:
self.logger.log_message(
'Sphinx project does not exist for ' +
'custom package "{0}".'.format(package))
def _generate_source_python_docs(self):
"""Generate Sphinx project files for Source.Python."""
project = SphinxProject(SP_PACKAGES_PATH, SP_DOCS_PATH)
if project.project_exists():
try:
project.generate_project_files('developing/modules')
except:
self.logger.log_message(
'An error occured while generating ' +
'project files for Source.Python')
else:
modules_dir = project.project_source_dir / 'developing' / 'modules'
modules_dir.joinpath('modules.rst').remove()
for file_path in modules_dir.files('source-python.*.rst'):
self._prepare_generated_source_python_file(file_path)
self.logger.log_message(
'Project files have been generated for Source.Python.')
else:
self.logger.log_message(
'Sphinx project does not exist for Source.Python.')
