journal_manager.cli.commands.journal_commands.create module

journal_manager.cli.commands.journal_commands.create.create(journal_title: str, journal_location_folder: Path, mkdocs_template_name: str | None = None)[source]

Creates a mkdocs journal file structure.

If the JOURNAL_LOCATION_FOLDER is not given, it uses the default_journal_folder defined in the file pointed by the JOURNAL_MANAGER_CONFIG_FOLDER environment variable is used.

The MKDOCS_TEMPLATE_NAME specifies a template to create the mkdocs.yml file. To see a list of available templates, use:

Example

journal-manager setup template

Parameters:

  • journal_title (str) – Name will be displayed in the html page.

  • journal_location_folder (Path) – Directory where the journal files will be created.

  • mkdocs_template_name (optional) – The name of a template file for mkdocs.yml.

Raises:

  • InvalidName if the mkdocs_template_name is not registered. –

  • InvalidTemplate if the registered template does not have a mkdocs.tpl.yml file. –

  • InvalidLocation if the journal_location_folder is an existent directory. –

Important

If the journal exist already it will be overwrite.

journal_manager.cli.commands.journal_commands.create.get_parser(subparser_action=None)[source]