greening.greening_config

class greening.greening_config.GreeningConfig(path=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/greening/checkouts/latest/docs/source/greening.yaml'))

Bases: object

Parameters:

path (Path) –

DEFAULT_YAML = '# Project metadata\nproject_name: My Greening Project\nproject_slug: my_greening_project\nauthor_name: Your Name\nemail: your@email.com\ngithub_username: your-github-username\n\n# Optional GitHub integration\n# To enable GitHub repo creation, set GITHUB_TOKEN in your environment.\n# This token must have repo scope.\n# For more info: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token\ngit_remote: git@github.com:None/my_greening_project.git\npush: false\n# create_github_repo: false\n    \n\n# Create a virtual environment using venv in the root of the project\nvenv:\n    create: false         # Whether to create a virtual environment\n    python: python3      # Python interpreter to use (optional)\n\n# Auto-generate and deploy a Jekyll site on GitHub Pages\ngithub_pages:\n  enabled: true\n  # google_analytics: G-XXXXXXXXXX\n'

__init__(path=PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/greening/checkouts/latest/docs/source/greening.yaml'))

Parameters:

path (Path) –

as_cookiecutter_context()

property docs_enabled

get(key, default=None)

property github_pages_enabled: bool

to_cookiecutter_context()

write_default()