https://github.com/jcook3701/sphinx-cookiecutter

Sphinx cookiecutter project for python3 project documentation.
https://github.com/jcook3701/sphinx-cookiecutter

cookiecutter documentation python3 sphinx

Last synced: about 1 month ago
JSON representation

Sphinx cookiecutter project for python3 project documentation.

• Host: GitHub
• URL: https://github.com/jcook3701/sphinx-cookiecutter
• Owner: jcook3701
• License: agpl-3.0
• Created: 2025-10-16T09:36:15.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2026-01-30T07:03:26.000Z (5 months ago)
• Last Synced: 2026-01-30T21:44:53.244Z (5 months ago)
• Topics: cookiecutter, documentation, python3, sphinx
• Language: Makefile
• Homepage:
• Size: 130 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: changelogs/CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          

sphinx-cookiecutter




Author: Jared Cook


Version: 0.1.0


Overview


sphinx cookiecutter template generation.




CI/CD Check List:




  


  


  


  


  


  


  






Usage Examples


Example: Pull from main branch.



  
Pull Project with cookiecutter command:

    


$ cookiecutter git@github.com:jcook3701/sphinx-cookiecutter.git  

    

    
Example: Pull from develop branch.

  

  
Pull code from development branch while testing updates.

    


$ cookiecutter git@github.com:jcook3701/sphinx-cookiecutter.git --checkout develop  

    

  



Advance Examples


Note: The real intention of this project is to call it as a hook within other cookiecutter projects as shown below.


Explanation: ansible-galaxy-cookiecutter template utilizes nutri-matic hooks to pull both this documentation template along with github-docs-cookiecutter template into generated project $(PROJECT_ROOT)/docs/.


Utilization of nutri-matic is the optimal way of integrating this template in projects.




Getting Started




  
Requirements

  
Installation guide



Documentation


The sphinx-cookiecutter documentation is available at docs.


Contributing


If you’re interested in contributing to the sphinx-cookiecutter project:



  
Start by reading the contributing guide.

  
Learn how to setup your local environment, in our developer guide.

  
Look through our style guide.



Authors Notes




  
This code currently works with cookiecutter (2.6+) from PyPi repositories.





License


Copyright (c) 2025-2026, Jared Cook


This project is licensed under the AGPL-3.0-or-later License.


See the LICENSE file for the full license text.


SPDX-License-Identifier: AGPL-3.0-or-later