Contributing Documentation

Last Updated: January 2025

The Tethys Platform documentation (https://docs.tethysplatform.org) is built using Sphinx and hosted on Read the Docs. The documentation is written using a lightweight markup language called reStructuredText. Sphinx converts the reStructuredText files into HTML, PDF, and other formats.

The following guides will help you get started with contributing to the Tethys Platform documentation. Review the list of guides below and select the one that best fits your interests.

Getting Started

Use this step-by-step guide to learn how to build the Sphinx documentation on your local machine. This is a great place to start if you are new to contributing to the Tethys Platform documentation.

• How to Build the Documentation

Guidelines

Learn the best practices for contributing to the Tethys Platform documentation in the following guide. This guide outlines the standards that should be followed when writing documentation for the Tethys Platform to ensure consistency and quality.

• Documentation Guidelines

Organization

Take in this high-level explanation of Tethys Platform documentation source files and how they are organized. This guide will help you understand the structure of the documentation source files and how to navigate them.

• Documentation Source Files
  • The docs Directory
  • Types of Documentation
  • The conf.py file

Publishing

Learn about how Tethys Platform uses Read the Docs to publish the documentation. This guide will help you understand how the documentation is built and published to the web.

• Read the Docs
  • Dashboard
  • Versions
  • Builds
  • Settings