{"id":35072560,"url":"https://github.com/jcook3701/sphinx-cookiecutter","last_synced_at":"2026-05-21T00:01:51.691Z","repository":{"id":321870961,"uuid":"1077465924","full_name":"jcook3701/sphinx-cookiecutter","owner":"jcook3701","description":"Sphinx cookiecutter project for python3 project documentation.","archived":false,"fork":false,"pushed_at":"2026-01-30T07:03:26.000Z","size":133,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-30T21:44:53.244Z","etag":null,"topics":["cookiecutter","documentation","python3","sphinx"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jcook3701.png","metadata":{"files":{"readme":"README.md","changelog":"changelogs/CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"buy_me_a_coffee":"jcook3701"}},"created_at":"2025-10-16T09:36:15.000Z","updated_at":"2026-01-30T06:25:52.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jcook3701/sphinx-cookiecutter","commit_stats":null,"previous_names":["jcook3701/sphinx-cookiecutter"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jcook3701/sphinx-cookiecutter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fsphinx-cookiecutter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fsphinx-cookiecutter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fsphinx-cookiecutter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fsphinx-cookiecutter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jcook3701","download_url":"https://codeload.github.com/jcook3701/sphinx-cookiecutter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jcook3701%2Fsphinx-cookiecutter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33281296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-20T15:12:43.734Z","status":"ssl_error","status_checked_at":"2026-05-20T15:12:42.300Z","response_time":356,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cookiecutter","documentation","python3","sphinx"],"created_at":"2025-12-27T11:57:44.439Z","updated_at":"2026-05-21T00:01:51.685Z","avatar_url":"https://github.com/jcook3701.png","language":"Makefile","funding_links":["https://buymeacoffee.com/jcook3701"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n  Auto-generated file. Do not edit directly.\n  Edit /home/jcook/Documents/git_repo/sphinx-cookiecutter/docs/jekyll/README.md instead.\n  Run ```make readme``` to regenerate this file\n--\u003e\n\u003ch1 id=\"sphinx-cookiecutter\"\u003esphinx-cookiecutter\u003c/h1\u003e\n\n\u003cp\u003e\u003ca href=\"LICENSE.md\"\u003e\u003cimg src=\"https://img.shields.io/github/license/jcook3701/sphinx-cookiecutter\" alt=\"License\" /\u003e\u003c/a\u003e\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eAuthor:\u003c/strong\u003e Jared Cook\u003cbr /\u003e\n\u003cstrong\u003eVersion:\u003c/strong\u003e 0.1.0\u003c/p\u003e\n\n\u003ch2 id=\"overview\"\u003eOverview\u003c/h2\u003e\n\n\u003cp\u003esphinx cookiecutter template generation.\u003c/p\u003e\n\n\u003chr /\u003e\n\n\u003cp\u003e\u003cstrong\u003eCI/CD Check List:\u003c/strong\u003e\u003c/p\u003e\n\n\u003cul\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/sphinx-cookiecutter/actions/workflows/dependency-check.yml/badge.svg\" alt=\"dependency-check\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/sphinx-cookiecutter/actions/workflows/format-check.yml/badge.svg\" alt=\"format-check\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/sphinx-cookiecutter/actions/workflows/lint-check.yml/badge.svg\" alt=\"lint-check\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/sphinx-cookiecutter/actions/workflows/security-audit.yml/badge.svg\" alt=\"security-audit\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/sphinx-cookiecutter/actions/workflows/spellcheck.yml/badge.svg\" alt=\"spellcheck\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/sphinx-cookiecutter/actions/workflows/tests.yml/badge.svg\" alt=\"tests\" /\u003e\u003c/li\u003e\n  \u003cli\u003e\u003cimg src=\"https://github.com/jcook3701/sphinx-cookiecutter/actions/workflows/typecheck.yml/badge.svg\" alt=\"typecheck\" /\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003chr /\u003e\n\n\u003ch2 id=\"usage-examples\"\u003eUsage Examples\u003c/h2\u003e\n\n\u003cp\u003e\u003cstrong\u003eExample:\u003c/strong\u003e Pull from main branch.\u003c/p\u003e\n\u003col\u003e\n  \u003cli\u003ePull Project with cookiecutter command:\n    \u003cdiv class=\"language-shell highlighter-rouge\"\u003e\u003cdiv class=\"highlight\"\u003e\u003cpre class=\"highlight\"\u003e\u003ccode\u003e\u003cspan class=\"nv\"\u003e$ \u003c/span\u003ecookiecutter git@github.com:jcook3701/sphinx-cookiecutter.git  \n\u003c/code\u003e\u003c/pre\u003e\u003c/div\u003e    \u003c/div\u003e\n    \u003cp\u003e\u003cstrong\u003eExample:\u003c/strong\u003e Pull from develop branch.\u003c/p\u003e\n  \u003c/li\u003e\n  \u003cli\u003ePull code from development branch while testing updates.\n    \u003cdiv class=\"language-shell highlighter-rouge\"\u003e\u003cdiv class=\"highlight\"\u003e\u003cpre class=\"highlight\"\u003e\u003ccode\u003e\u003cspan class=\"nv\"\u003e$ \u003c/span\u003ecookiecutter git@github.com:jcook3701/sphinx-cookiecutter.git \u003cspan class=\"nt\"\u003e--checkout\u003c/span\u003e develop  \n\u003c/code\u003e\u003c/pre\u003e\u003c/div\u003e    \u003c/div\u003e\n  \u003c/li\u003e\n\u003c/ol\u003e\n\n\u003ch2 id=\"advance-examples\"\u003eAdvance Examples\u003c/h2\u003e\n\n\u003cp\u003e\u003cstrong\u003eNote:\u003c/strong\u003e The real intention of this project is to call it as a hook within other cookiecutter projects as shown below.\u003cbr /\u003e\n\u003cstrong\u003eExplanation:\u003c/strong\u003e \u003ca href=\"https://github.com/jcook3701/ansible-galaxy-cookiecutter\"\u003eansible-galaxy-cookiecutter\u003c/a\u003e template utilizes \u003ca href=\"https://github.com/jcook3701/nutri-matic\"\u003enutri-matic\u003c/a\u003e hooks to pull both this documentation template along with \u003ca href=\"https://github.com/jcook3701/github-docs-cookiecutter\"\u003egithub-docs-cookiecutter\u003c/a\u003e template into generated project \u003ccode class=\"language-plaintext highlighter-rouge\"\u003e$(PROJECT_ROOT)/docs/\u003c/code\u003e.\u003c/p\u003e\n\n\u003cp\u003eUtilization of \u003ca href=\"https://github.com/jcook3701/nutri-matic\"\u003enutri-matic\u003c/a\u003e is the optimal way of integrating this template in projects.\u003c/p\u003e\n\n\u003chr /\u003e\n\n\u003ch2 id=\"getting-started\"\u003eGetting Started\u003c/h2\u003e\n\n\u003cul\u003e\n  \u003cli\u003e\u003ca href=\"https://jcook3701.github.io/sphinx-cookiecutter/manual/setup-guide/requirements\"\u003eRequirements\u003c/a\u003e\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"https://jcook3701.github.io/sphinx-cookiecutter/manual/introduction/installation-guide\"\u003eInstallation guide\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003ch2 id=\"documentation\"\u003eDocumentation\u003c/h2\u003e\n\n\u003cp\u003eThe sphinx-cookiecutter documentation is available at \u003ca href=\"https://jcook3701.github.io/sphinx-cookiecutter\"\u003edocs\u003c/a\u003e.\u003c/p\u003e\n\n\u003ch2 id=\"contributing\"\u003eContributing\u003c/h2\u003e\n\n\u003cp\u003eIf you’re interested in contributing to the sphinx-cookiecutter project:\u003c/p\u003e\n\u003cul\u003e\n  \u003cli\u003eStart by reading the \u003ca href=\"https://jcook3701.github.io/sphinx-cookiecutter/manual/developer-resources/contribute\"\u003econtributing guide\u003c/a\u003e.\u003c/li\u003e\n  \u003cli\u003eLearn how to setup your local environment, in our \u003ca href=\"https://jcook3701.github.io/sphinx-cookiecutter/manual/contribute/developer-guide\"\u003edeveloper guide\u003c/a\u003e.\u003c/li\u003e\n  \u003cli\u003eLook through our \u003ca href=\"https://jcook3701.github.io/sphinx-cookiecutter/manual/contribute/style-guides/index\"\u003estyle guide\u003c/a\u003e.\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003ch2 id=\"authors-notes\"\u003eAuthors Notes\u003c/h2\u003e\n\n\u003col\u003e\n  \u003cli\u003eThis code currently works with cookiecutter (2.6+) from PyPi repositories.\u003c/li\u003e\n\u003c/ol\u003e\n\n\u003chr /\u003e\n\n\u003ch2 id=\"license\"\u003eLicense\u003c/h2\u003e\n\n\u003cp\u003eCopyright (c) 2025-2026, Jared Cook\u003c/p\u003e\n\n\u003cp\u003eThis project is licensed under the \u003cstrong\u003eAGPL-3.0-or-later License\u003c/strong\u003e.\u003cbr /\u003e\nSee the \u003ca href=\"https://github.com/jcook3701/sphinx-cookiecutter/blob/master/LICENSE.md\"\u003eLICENSE\u003c/a\u003e file for the full license text.\u003c/p\u003e\n\n\u003cp\u003eSPDX-License-Identifier: AGPL-3.0-or-later\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcook3701%2Fsphinx-cookiecutter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjcook3701%2Fsphinx-cookiecutter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjcook3701%2Fsphinx-cookiecutter/lists"}