mloq.commands.docs#

Mloq docs command implementation.

Module Contents#

Classes#

DocsCMD

Implement the functionality of the docs Command.

Attributes#

DOCS_ASSETS_PATH

makefile_docs

make_bat_docs

docs_req

conf_py

index_md

deploy_docs

DOCS_FILES

mloq.commands.docs.DOCS_ASSETS_PATH#
mloq.commands.docs.makefile_docs#
mloq.commands.docs.make_bat_docs#
mloq.commands.docs.docs_req#
mloq.commands.docs.conf_py#
mloq.commands.docs.index_md#
mloq.commands.docs.deploy_docs#
mloq.commands.docs.DOCS_FILES#
class mloq.commands.docs.DocsCMD(record, interactive=False, **kwargs)[source]#

Bases: mloq.command.Command

Implement the functionality of the docs Command.

Parameters

  • record (mloq.writer.CMDRecord) –

  • interactive (bool) –

cmd_name = docs#
disable#
project_name#
description#
author#
copyright_year#
copyright_holder#
deploy_docs#
default_branch#
project_url#
files#
property directories#

Tuple containing Paths objects representing the directories created by the command.

Return type

Tuple[pathlib.Path]

interactive_config()[source]#

Generate the configuration of the project interactively.

Return type

omegaconf.DictConfig

record_files()[source]#

Register the files that will be generated by mloq.

Return type

None