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

A Cookiecutter template for generating Sphinx extensions
https://github.com/sphinx-notes/cookiecutter

cookiecutter cookiecutter-python cookiecutter-template sphinx sphinx-extension

Last synced: 26 days ago
JSON representation

A Cookiecutter template for generating Sphinx extensions

• Host: GitHub
• URL: https://github.com/sphinx-notes/cookiecutter
• Owner: sphinx-notes
• License: bsd-3-clause
• Created: 2023-01-31T11:18:38.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2025-10-16T23:25:38.000Z (4 months ago)
• Last Synced: 2025-10-18T02:49:08.998Z (4 months ago)
• Topics: cookiecutter, cookiecutter-python, cookiecutter-template, sphinx, sphinx-extension
• Language: Python
• Homepage:
• Size: 111 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
===============================

Sphinx Notes Extension Template

===============================

A Cookiecutter_ template for generating Sphinx extensions.

Usage

=====

We use Cruft_ to create project interactively::

   $ cruft create https://github.com/sphinx-notes/cookiecutter

   namespace [sphinxnotes]:

   name [demo]:

   full_name [sphinxnotes-demo]:

   ...

To keep sync with the newst template::

   $ cd demo

   $ make tmpl-update

   ...

   $ make tmpl-update-done

Acknowledgment

==============

- Cookiecutter_

- `Cookiecutter PyPackage`_

- PyScaffold_

- Cruft_

.. _Cookiecutter: https://github.com/cookiecutter/cookiecutter

.. _Cookiecutter PyPackage: https://github.com/cookiecutter/cookiecutter

.. _PyScaffold: https://pyscaffold.org/en/stable/extensions.html

.. _Cruft: https://github.com/cruft/cruft