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

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

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

☕ Support Me

If you enjoy this project, please consider buying me a coffee or making a code contribution.