.. template-project documentation master file

====================================
Template Project: Documentation Hub
====================================

Welcome to the documentation for the **template-project** — a minimal, modern Python project template designed for research groups and scientific code development.

This template includes tools for testing, documentation, versioning, citation, publishing to PyPI, and more. Whether you're working solo or collaborating in a team, this guide will help you get started and stay consistent.

.. toctree::
   :maxdepth: 2
   :caption: Getting started

   setup.md
   customisation_checklist.md
   project_structure.md

.. toctree::
   :maxdepth: 2
   :caption: GitHub basics

   github_intro.md
   github_tags_guide.md
   gitworkflow_solo.md
   gitcollab.md


.. toctree::
   :maxdepth: 2
   :caption: Development Guide

   style_guide.md
   writing_tests.md
   build_docs.md
   precommit_guide.md
   actions_overview.md


.. toctree::
   :maxdepth: 2
   :caption: Project Management

   citation_guide.md
   pypi_guide.md
   gitorg_transfer.md

.. toctree::
   :maxdepth: 2
   :caption: Development

   Development Roadmap <../../MODERNIZATION_PLAN.md>

.. toctree::
   :maxdepth: 3
   :caption: Users' guide

   demo-output.ipynb



.. toctree::
   :maxdepth: 2
   :caption: Help and reference

   GitHub Repo <http://github.com/eleanorfrajka/template-project>
   template_project
   faq

These documentation pages were created based on processes used to develop and maintain http://github.com/OceanGlidersCommunity/glidertest and edited using chatGPT.