src.utils.generate_yml_content

Module Contents

src.utils.generate_yml_content.generate_gitlab_ci_file() → str

Generates the contents of a .gitlab-ci.yml file for building docs.

Returns:

GitLab CI configuration content.

Return type:

str

src.utils.generate_yml_content.generate_github_actions_file() → str

Generates a GitHub Actions workflow file for building Sphinx docs.

Returns:

Workflow file content.

Return type:

str

src.utils.generate_yml_content.generate_github_pages_index(project_name: str = 'API Documentation') → str

Generates a small landing page for a branch-based GitHub Pages site.

Parameters:

project_name (str) – Display name shown on the landing page.

Returns:

Static HTML content.

Return type:

str