core.command.docs module

Registers the sp docs sub-commands.

core.command.docs._build_custom_package_docs(package)[source]

Build Sphinx project files for a custom package.

core.command.docs._build_plugin_docs(package)[source]

Build Sphinx project files for a plugin.

core.command.docs._build_source_python_docs()[source]

Build Sphinx project files for Source.Python.

core.command.docs._build_sphinx_project(package)[source]

Build project files for a Sphinx project.

core.command.docs._create_custom_package_docs(package)[source]

Create a Sphinx project for a custom package.

core.command.docs._create_plugin_docs(package)[source]

Create a Sphinx project for a plugin.

core.command.docs._create_source_python_docs()[source]

Create a Sphinx project for Source.Python.

core.command.docs._create_sphinx_project(package)[source]

Create a Sphinx project.

core.command.docs._generate_custom_package_docs(package)[source]

Generate Sphinx project files for a custom package.

core.command.docs._generate_plugin_docs(package)[source]

Generate Sphinx project files for a plugin.

core.command.docs._generate_source_python_docs()[source]

Generate Sphinx project files for Source.Python.

core.command.docs._generate_sphinx_project(package)[source]

Generate project files for a Sphinx project.

core.command.docs._get_updated_credits_wiki()[source]

Return the content for the credits.rst.

core.command.docs._prepare_generated_source_python_file(file_path)[source]

Rename the generated file if it wasn’t already renamed.

If it was already renamed, remove the generated file.

After renaming the file several patches are applied to the file like removing ‘source-python.’ and adding the ‘:titlesonly:’ directive.

core.command.docs._sp_docs_build(command_info, package)[source]

Build a Sphinx project.

core.command.docs._sp_docs_create(command_info, package)[source]

Create a Sphinx project.

core.command.docs._sp_docs_generate(command_info, package)[source]

Generate a Sphinx project.

core.command.docs.is_custom_package(package)[source]

Return True if the given package name is a custom package.

core.command.docs.is_plugin(package)[source]

Return True if the given package name is a plugin.

core.command.docs.is_source_python(package)[source]

Return True if the given package name is source-python.