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.

• Sphinx & MkDocs Guides
  • Adding Custom CSS or JavaScript to Sphinx Documentation
  • Cross-referencing with Sphinx
  • Link to Other Projects’ Documentation With Intersphinx
  • How to use Jupyter notebooks in Sphinx
  • Manage Translations
  • Building With Pre-1.0 Versions Of MkDocs
  • Sphinx PDFs with Unicode
  • Removing “Edit on …” Buttons from Documentation
  • Version Control System Integration
• Read the Docs Guides
  • Enabling Build Notifications
  • My Build is Using Too Many Resources
  • Canonical URLs
  • Conda Support
  • Deprecating Content on Read the Docs
  • Embedding Content From Your Documentation
  • I Need Secrets (or Environment Variables) in my Build
  • Feature Flags
  • Enabling Google Analytics on your Project
  • Hide a Version and Keep its Docs Online
  • Reproducible Builds
  • Searching with Read the Docs
  • Technical Documentation Search Engine Optimization (SEO) Guide
  • Wiping a Build Environment
• Read the Docs for Business Guides
  • Manually Importing Private Repositories
  • Installing Private Python Packages
  • Using Private Git Submodules