astropy / package-template

Template for packages that use Astropy. Maintainer: @astrofrog
http://docs.astropy.org/projects/package-template/en/latest/
Other
60 stars 63 forks source link

Don't default to docs layout with a sub-directory for the package #419

Closed astrofrog closed 1 year ago

astrofrog commented 5 years ago

The docs layout in:

https://github.com/astropy/package-template/blob/cookiecutter/%7B%7B%20cookiecutter.package_name%20%7D%7D/docs/index.rst

was originally used because the template was for use (initially) by a number of packages that might end up being merged into the core. This is very much no longer the case, so we should default to just having the top-level docs in docs, not docs/packagename

Cadair commented 5 years ago

I am sad I only have one :+1: to give.

We have already patched this out of the sunpy fork iirc.

bsipocz commented 5 years ago

sounds good to me

astrofrog commented 4 years ago

Anyone want to do a quick PR for this? :)

pllim commented 1 year ago

https://github.com/astropy/package-template#deprecation-warning