Documentation Guide

Contents

• Getting started
  • Preparing for your first contribution
  • Developing your contribution
  • Testing changes
  • Creating a pull request
  • Asking questions
• Understanding our workflow
• Tools for documentation
  • Packages
  • Source file formats
  • Sphinx themes
  • Git and Github Resources
• Setting up a project’s documentation infrastructure
  • Structuring a repo for docs
  • Setting up a README
  • Building automatically on ReadTheDocs
  • Supporting translations of documentation
• Documentation Issue Hub
  • Docs Issues Per-Subproject

Documentation helps guide new users, fosters communication between developers, and shares tips and best practices with other community members. That’s why the Jupyter project is focused on documenting new features and to keeping the documentation up-to-date.