pyOpenSci / pyos-package-template

A Python package template that supports the pyOpenSci pure Python packaging tutorial
BSD 3-Clause "New" or "Revised" License
15 stars 11 forks source link

Add a description of the generated template files #9

Closed choldgraf closed 5 years ago

choldgraf commented 5 years ago

It'd be useful to keep a page that describes that each of the files generated in the template is used for. E.g. we should show a tree output:

python_boilerplate/
├── CONTRIBUTING.rst
├── CONTRIBUTORS.rst
├── docs
│   ├── conf.py
│   ├── contributing.rst
│   ├── contributors.rst
│   ├── history.rst
│   ├── index.rst
│   ├── installation.rst
│   ├── make.bat
│   ├── Makefile
│   ├── readme.rst
│   └── usage.rst
├── HISTORY.rst
├── LICENSE
├── Makefile
├── MANIFEST.in
├── python_boilerplate
│   ├── __init__.py
│   └── python_boilerplate.py
├── README.rst
├── requirements_dev.txt
├── setup.cfg
├── setup.py
├── tests
│   └── test_python_boilerplate.py
└── tox.ini

and make sure we link out or have a description for each major thing that's there. Maybe this already exists for the original cookiecutter?

kysolvik commented 5 years ago

I like this idea. I don't think there's anything in the original cookiecutter-pypackage (I more or less directly ported the documentation). I'll work on putting something together and adding it to the docs

kysolvik commented 5 years ago

Done #10