Logo

Getting started

  • Tutorial
  • 增添文件專案
  • 熱門文件工具
  • 範例專案

專案設定與組態

  • Configuration file overview
  • Configuration file reference
  • Read the Docs Addons
  • Account authentication methods
  • Automation rules
  • How to create reproducible builds

Build process

  • Build process overview
  • Build process customization
  • Git integration (GitHub, GitLab, Bitbucket)
  • 拉取請求預覽
  • 建置失敗通知
  • 環境變數概覽
  • 環境變數參考

託管文件

  • Versions
  • 子專案
  • 在地化與國際化
  • URL versioning schemes
  • 自訂域名
  • URL path prefixes
  • 文件通知
  • Canonical URLs
  • Content Delivery Network (CDN) and caching
  • Sitemap support
  • 404 Not Found pages
  • robots.txt support
  • llms.txt support

閱讀文件

  • Offline formats (PDF, ePub, HTML)
  • Visual diff
  • 連結預覽
  • How to embed content from your documentation
  • Server side search
  • 搜尋查詢語法
  • 飛出式選單

維護專案

  • Redirects
  • Traffic analytics
  • Search analytics
  • Security logs
  • 狀態徽章
  • How to structure your documentation
  • Best practices for linking to your documentation
  • Security considerations for documentation pages
  • Main content detection
  • AI agent skills
  • Custom script

Business features

  • Business hosting
  • Organizations
  • 單一登入(SSO)
  • Sharing private documentation
  • 如何管理您的訂閱
  • Privacy levels

操作指南

  • 專案設定與組態
  • Build process
  • Upgrading and maintaining projects
  • Content, themes and SEO
  • Security and access
  • 帳號管理
  • 最佳實踐
  • Troubleshooting problems

Reference

  • Public REST API
  • 常見問題集
  • 變更日誌
  • 關於 Read the Docs
  • 開發者文件
  • Read the Docs 網站
Read the Docs user documentation
  • 索引
  • Edit on GitHub

索引

C | D | F | G | M | P | R | S | U | V | W | 環

C

  • CI/CD
  • configuration file

D

  • dashboard
  • default version
  • diff
  • discoverability
  • Docs as Code

F

  • flyout menu

G

  • GitOps

M

  • maintainer

P

  • pinning
  • pre-defined build jobs
  • project home
  • project page
  • Python Enhancement Proposals
    • PEP 287
    • PEP 440

R

  • READTHEDOCS, [1]
  • READTHEDOCS_GIT_CLONE_URL
  • READTHEDOCS_GIT_IDENTIFIER
  • READTHEDOCS_REPOSITORY_PATH
  • reproducible
  • root URL

S

  • slug
  • static website
  • subproject

U

  • user-defined build jobs

V

  • virtualenv

W

  • webhook

環

  • 環境變數
    • READTHEDOCS, [1], [2]
    • READTHEDOCS_CANONICAL_URL
    • READTHEDOCS_GIT_CLONE_URL, [1]
    • READTHEDOCS_GIT_COMMIT_HASH
    • READTHEDOCS_GIT_IDENTIFIER, [1]
    • READTHEDOCS_LANGUAGE
    • READTHEDOCS_OUTPUT
    • READTHEDOCS_PRODUCTION_DOMAIN
    • READTHEDOCS_PROJECT
    • READTHEDOCS_REPOSITORY_PATH, [1]
    • READTHEDOCS_VERSION
    • READTHEDOCS_VERSION_NAME
    • READTHEDOCS_VERSION_TYPE
    • READTHEDOCS_VIRTUALENV_PATH

© Copyright Read the Docs, Inc & contributors.

Built with Sphinx using a theme provided by Read the Docs.