Skip to content

Fundamental Documentation #2

Open
@Cadair

Description

@Cadair

Things we need to document here:

  • Creating a new package using the template
    • Install cookiecutter
    • Run cookiecutter
    • Answering questions, what they all mean etc
    • git init
    • How to use the CI configs, RTD and pre-commit
    • pre-commit (it runs as part of tox so needs to be run to make sure it passes).
  • Updating a package with a new version of the template
    • .sunpy-template.yml
    • Run cookiecutter --no-input --config-file .sunpy-template.yml
    • review diff, drop some changes, stage others.
    • How to detect files removed by the template?
  • Removal of astropy_helpers + upgrade from old templates.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions