Python to ReadtheDocs Guide

A beginners guide to integrating a Python project with Read the Docs to create great hassle-free documentation. Read More

Contents:

• Introduction
• Install Sphinx
  • Pre-Work
    • Ensure packages are up-to-date
    • Install Python pip
  • Sphinx Installation
• Configure Sphinx
  • sphinx-quickstart
• Autodoc Your Code
  • Tell autodoc how to Find your Code
    • Submodules
  • One-Off Creation of RST Files
  • autodoc directives
  • Documenting Your Code
• Create Content
  • Updating the Index
• reStructuredText
  • reStructuredText Conventions
    • Line length
  • Headings
    • H1
    • H2
    • H3
    • H4
    • H5
    • H6
  • Text Formatting
    • Italics
    • bold
    • literal
  • Lists
    • Numbered Lists
    • Bullet Points
  • Code Blocks
    • Command Line
    • Python
  • Hyperlinks
    • Simple link
    • Link with name
    • Link to local page
  • Images
• Local Build
• UI Tweaks
  • Themes
  • Sidebar
• Read the Docs Integration
  • Integrate with ReadtheDocs
    • Sign up with Read the Docs
    • Set up Service on GitHub
    • Import Project in Read the Docs
    • Check Read the Docs Versions
  • Autodoc Fix for External Module Dependencies
    • Example of Import Problem
    • Fixing Missing Imports with virtualenv
    • Fixing Missing Imports with Mock
• Module Documentation
  • example_module module
  • example_module2 module
• Troubleshooting
  • Static Page Problems
    • Why isn’t my page showing up in the contents menu?
    • Why isn’t my page loading / display correctly?
  • Autodoc Problems
    • Module files missing or incomplete
• Acknowledgements

Indices and tables

• Index
• Module Index
• Search Page