Merge pull request #23 from 56kyle/develop

Develop

Author: 56kyle

.readthedocs.yml

@@ -4,5 +4,10 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.13"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
 sphinx:
   configuration: docs/conf.py

cookiecutter.json

@@ -7,7 +7,9 @@
   "add_rust_extension": false,
   "author": "Kyle Oliver",
   "email": "56kyleoliver+cookiecutter-robust-python@gmail.com",
-  "github_user": "56kyle",
+  "repository_provider": ["github", "gitlab", "bitbucket"],
+  "repository_host": "{% if cookiecutter.repository_provider == 'github' %}github.com{% elif cookiecutter.repository_provider == 'gitlab' %}gitlab.com{% else %}bitbucket.org{% endif %}",
+  "repository_path": "56kyle/{{ cookiecutter.project_name.replace('_', '-') }}",
   "version": "0.0.0",
   "copyright_year": "{% now 'utc', '%Y' %}",
   "license": ["MIT", "Apache-2.0", "GPL-3.0"],

docs/requirements.txt

@@ -0,0 +1,7 @@
+furo==2024.8.6
+myst-parser==4.0.1
+sphinx==8.2.3
+sphinx-autodoc-typehints==3.2.0
+sphinx-copybutton==0.5.2
+sphinx-tabs==3.4.7
+sphinxcontrib-typer==0.5.1

{{cookiecutter.project_name}}/.cz.toml

@@ -16,4 +16,4 @@ update_changelog_on_bump = true
 release = true
 release_asset_path = "dist/*"
 release_asset_descriptions = { "*.tar.gz" = "Source distribution", "*.whl" = "Python Wheel" }
-base_url = "https://github.com/{{ cookiecutter.github_user | lower | replace(' ', '-') }}/{{ cookiecutter.project_name.replace('_', '-') }}"
+base_url = "https://{{ cookiecutter.repository_host }}/{{ cookiecutter.repository_path }}"

{{cookiecutter.project_name}}/.github/workflows/{% if cookiecutter.add_rust_extension == 'y' %} lint-rust.yml {%- endif %}

@@ -4,5 +4,11 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.13"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - path: .
+
 sphinx:
   configuration: docs/conf.py