Guides

These guides will help walk you through specific use cases related to Read the Docs itself, documentation tools like Sphinx and MkDocs and how to write successful documentation.

• Guides for documentation authors
  • Cross-referencing with Sphinx
  • Link to external projects (Intersphinx)
  • How to use Jupyter notebooks in Sphinx
  • Migrate from rST to MyST
• Guides for project administrators
  • Technical Documentation Search Engine Optimization (SEO) Guide
  • Manage Translations for Sphinx projects
  • Hide a Version and Keep its Docs Online
  • Deprecating Content
  • Sphinx PDFs with Unicode
  • Manually Importing Private Repositories
  • Setup Build Notifications
• Guides for developers and designers
  • Installing Private Python Packages
  • Using Private Git Submodules
  • Adding Custom CSS or JavaScript to Sphinx Documentation
  • Reproducible Builds
  • Embedding Content From Your Documentation
  • Conda Support
  • Removing “Edit on …” Buttons from Documentation
  • My Build is Using Too Many Resources
  • Adding “Edit Source” links on your Sphinx theme
  • Setup Build Notifications