template_project Logo

Getting started

  • Getting Started: Setup and Installation
  • Customisation Checklist for New Projects
  • What’s in This Template Project?
  • 📁 template-project File Structure

GitHub basics

  • Getting Started with GitHub
  • GitHub Tags for Oceanographic Projects
  • Solo Git Workflow for Your Project
  • Collaborating on Someone Else’s Repository

Development Guide

  • Project Style Guide
  • Writing and Running Tests
  • Building Documentation Locally
  • Setting Up Pre-commit Hooks
  • GitHub Actions: Automating Your Project

Project Management

  • How to Cite This Project
  • Publishing Your Project to PyPI
  • Transferring a Repository to an Organisation

Users' guide

  • template-project demo

Help and reference

  • GitHub Repo
  • template_project API
  • FAQ / Troubleshooting
template_project
  • Search

© Copyright 2025, Eleanor Frajka-Williams, FirstName LastName.

Built with Sphinx using a theme provided by Read the Docs.