Documentation guide

2i2c uses the same documentation setup across all of our repositories. This uses the Sphinx documentation engine in Python along with a custom Sphinx theme called the 2i2c-sphinx-theme that we use to standardize the look and feel and some menu items across all of our documentation sites.

See the sections below for more information about the structure and instructions for editing our documentation.

• Edit the documentation
  • Make edits with the GitHub UI
  • Edit documentation locally
• Write content with MyST markdown
  • MyST Markdown overview
  • MyST Markdown cheat-sheet
  • Interactive MyST explorer
• Set up a local documentation environment
  • Install Python
  • Install git
  • Install nox
  • Manually install the environment for documentation
• Guidelines for documentation structure
  • The general public
  • Hub users
  • Hub administrators
  • 2i2c engineers
• Sources of documentation