From 3e95afcc3dbd6ae16eec1f14cb671f44e4e06691 Mon Sep 17 00:00:00 2001 From: Lukas Heumos Date: Tue, 23 Apr 2024 21:47:19 +0200 Subject: [PATCH 1/2] Use cookiecutter variable for project repo in conf.py --- {{cookiecutter.project_name}}/docs/conf.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/{{cookiecutter.project_name}}/docs/conf.py b/{{cookiecutter.project_name}}/docs/conf.py index 64484fd5..bcad7690 100644 --- a/{{cookiecutter.project_name}}/docs/conf.py +++ b/{{cookiecutter.project_name}}/docs/conf.py @@ -1,5 +1,5 @@ # Configuration file for the Sphinx documentation builder. -# + # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html @@ -36,9 +36,9 @@ html_context = { "display_github": True, # Integrate GitHub - "github_user": "{{cookiecutter.github_user}}", # Username - "github_repo": project_name, # Repo name - "github_version": "main", # Version + "github_user": "{{cookiecutter.github_user}}", + "github_repo": "{{cookiecutter.project_repo}}", + "github_version": "main", "conf_py_path": "/docs/", # Path in the checkout to the docs root } From fae0e0716e5f4c38c44399c3d1a5ffe799f8bde7 Mon Sep 17 00:00:00 2001 From: Lukas Heumos Date: Tue, 23 Apr 2024 21:48:53 +0200 Subject: [PATCH 2/2] Remove useless comments --- {{cookiecutter.project_name}}/docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/docs/conf.py b/{{cookiecutter.project_name}}/docs/conf.py index bcad7690..312f8699 100644 --- a/{{cookiecutter.project_name}}/docs/conf.py +++ b/{{cookiecutter.project_name}}/docs/conf.py @@ -39,7 +39,7 @@ "github_user": "{{cookiecutter.github_user}}", "github_repo": "{{cookiecutter.project_repo}}", "github_version": "main", - "conf_py_path": "/docs/", # Path in the checkout to the docs root + "conf_py_path": "/docs/", } # -- General configuration ---------------------------------------------------