jcloud-docsgen/docs/reference/jcloud_docsgen/cli/languages/python.md

Module jcloud_docsgen.cli.languages.python

Function parse_sections_list

Returns a Python definition documentation sections list from the sections list to be included and the sections list to be excluded. These lists both consist of the sections as strings which contain the section name.

Function signature

parse_sections_list(include_sections: list[str] | None = None, exclude_sections: list[str] = []) -> PythonDefinitionDocumentationIncludeSections

Returns

The Python definition documentation sections object.

Return type: PythonDefinitionDocumentationIncludeSections

Parameters

Parameter	Type	Kind	Default value	Description
include_sections	`list[str]	None`	normal	None
exclude_sections	list[str]	normal	[]	The list of sections to be excluded.

Docstring

Returns a Python definition documentation sections list from the sections list to be included and the sections list to be excluded. These lists both consist of the sections as strings which contain the section name.

:param include_sections: The list of sections to be included. :type include_sections: list[str] | None :param exclude_sections: The list of sections to be excluded. :type exclude_sections: list[str]

:return: The Python definition documentation sections object. :rtype: PythonDefinitionDocumentationIncludeSections

Function _generate

Generates the documentation for a Python project.

Function signature

_generate(project_directory: pathlib.Path, output_directory: pathlib.Path, *, include_sections: PythonDefinitionDocumentationIncludeSections = PythonDefinitionDocumentationIncludeSections(), allow_html: bool = False, allow_tables: bool = False, force: bool = False) -> None

Returns

Return type: None

Parameters

Parameter	Type	Kind	Default value	Description
project_directory	pathlib.Path	normal	--	The project directory.
output_directory	pathlib.Path	normal	--	The output directory.
include_sections	PythonDefinitionDocumentationIncludeSections	keyword-only	PythonDefinitionDocumentationIncludeSections()	The sections to be included in the documentation.
allow_html	bool	keyword-only	False	Indicates whether HTML is allowed to appear in the generated documentation.
allow_tables	bool	keyword-only	False	Indicates whether Markdown tables are allowed. Warning: Markdown tables are not CommonMark.
force	bool	keyword-only	False	Indicates whether the output directory shall be overwritten if it is not empty.

Docstring

Generates the documentation for a Python project.

:param project_directory: The project directory. :type project_directory: pathlib.Path :param output_directory: The output directory. :type output_directory: pathlib.Path :param include_sections: The sections to be included in the documentation. :type include_sections: PythonDefinitionDocumentationIncludeSections :param allow_html: Indicates whether HTML is allowed to appear in the generated documentation. :type allow_html: bool :param allow_tables: Indicates whether Markdown tables are allowed. Warning: Markdown tables are not CommonMark. :param force: Indicates whether the output directory shall be overwritten if it is not empty. :type force: bool

Function generate

Generates the documentation for a Python project.

Function signature

generate(project_directory: pathlib.Path, output_directory: pathlib.Path, *, include_sections: list[str] | None = None, exclude_sections: list[str] = [], allow_html: bool = False, allow_tables: bool = False, force: bool = False) -> None

Returns

Return type: None

Parameters

Parameter	Type	Kind	Default value	Description
project_directory	pathlib.Path	normal	--	The project directory.
output_directory	pathlib.Path	normal	--	The output directory.
include_sections	`list[str]	None`	keyword-only	None
exclude_sections	list[str]	keyword-only	[]	The sections to be excluded in the documentation.
allow_html	bool	keyword-only	False	Indicates whether HTML is allowed to appear in the generated documentation.
allow_tables	bool	keyword-only	False	Indicates whether Markdown tables are allowed. Warning: Markdown tables are not CommonMark.
force	bool	keyword-only	False	Indicates whether the output directory shall be overwritten if it is not empty.

Docstring

Generates the documentation for a Python project.

:param project_directory: The project directory. :type project_directory: pathlib.Path :param output_directory: The output directory. :type output_directory: pathlib.Path :param include_sections: The sections to be included in the documentation. :type include_sections: list[str] | None :param exclude_sections: The sections to be excluded in the documentation. :type exclude_sections: list[str] :param allow_html: Indicates whether HTML is allowed to appear in the generated documentation. :type allow_html: bool :param allow_tables: Indicates whether Markdown tables are allowed. Warning: Markdown tables are not CommonMark. :param force: Indicates whether the output directory shall be overwritten if it is not empty. :type force: bool