cookiecutter icon indicating copy to clipboard operation
cookiecutter copied to clipboard

Published 20 hours ago • verified publisher icon sphinx-contrib

update global structure ?

Open 12rambau opened this issue 2 years ago • 3 comments
trafficstars

I started to use cookiecutter for various things and I didn't realized there was a specific one for extentions. Would you be interested in updating the strucure to more modern Python ?

  • use pre-commits
  • use github actions
  • rely on a single pyproject.toml file
  • add config to build documentation (with default pages like landing, contribute, API)

12rambau avatar Jun 26 '23 08:06 12rambau

Sure, go for it.

stephenfin avatar Jun 26 '23 10:06 stephenfin

Basically sorted in https://github.com/sphinx-contrib/cookiecutter/pull/25

daquintero avatar Jan 11 '24 11:01 daquintero

sorry @daquintero for washing away some of your effort I didn't saw you started working on my issue. In short I moved away from cookicutter as it was not allowing me to update my packages when I was discovering new things about python envirnment e.g. :

  • setuptools -> hatchling
  • tox -> nox
  • flake8 -> ruff

To reflect that I created a copier template for sphinx based extention and saved it here: https://github.com/sphinx-contrib/copier-sphinxcontrib

I also published a skeleton extention here applying as much as possible the instructions of the readme: https://github.com/sphinx-contrib/sphinxcontrib-skeleton

I would be curious to get your feedback on both and see with @stephenfin if it would make sense to archive this repository in favor of the copier template (this is what we did in jupyter for lab plugins)

12rambau avatar Jan 31 '24 18:01 12rambau