Skip to main content
Ctrl+K
Logo image Logo image

Site Navigation

  • Try Jupyter
  • Usage
  • Projects
  • Community
  • Contributing
  • Reference
  • jupyter.org

Site Navigation

  • Try Jupyter
  • Usage
  • Projects
  • Community
  • Contributing
  • Reference
  • jupyter.org

Section Navigation

  • Getting Started Contributing
  • Developer Guide
    • How can I help?
    • Jupyter Enhancement Proposals
    • Basic template for releasing a Jupyter project
  • Documentation Guide
    • Getting started
    • Understanding our workflow
    • Tools for documentation
    • Setting up a project’s documentation infrastructure
      • Structuring a repo for docs
      • Setting up a README
      • Building automatically on ReadTheDocs
      • Supporting translations of documentation
  • Communications Guide
  • IPython Development Guide (source: old IPython wiki)
    • IPython on GitHub
    • The Perfect Pull Request
    • Coding Style
    • Documenting IPython
    • Lab Meetings on Air
    • Policy on Closing Pull Requests
    • Testing IPython for users and developers
    • How to Compile .less Files
    • Steps for Releasing IPython
    • IPython Sphinx Directive
    • Python 3 Compatibility Module
    • Architecture of IPython notebook’s Dashboard
    • JavaScript Events
    • Setup IPython development environment using boot2docker
    • Testing Kernels

Setting up a project’s documentation infrastructure#

Contents:

  • Structuring a repo for docs
  • Setting up a README
  • Building automatically on ReadTheDocs
  • Supporting translations of documentation

This section helps a contributor set up the documentation infrastructure for a new project or an existing project without Sphinx documentation.

previous

Tools for documentation

next

Structuring a repo for docs

Edit this page
Show Source

© Copyright 2015, Jupyter Team, https://jupyter.org.

Built with the PyData Sphinx Theme 0.12.0.

Created using Sphinx 4.5.0.