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
    • Policies and legal documents
      • Abandoned projects policy
      • Unofficial and unmaintained projects policy
      • Privacy Policy
      • Security policy
      • Security reports
      • `Terms of Service <https://about.readthedocs.com/terms-of-service/>`_
      • DMCA takedown policy
      • Data Processing Addendum (DPA)
    • Advertising
    • The story of Read the Docs
    • Read the Docs 的贊助者
    • Documentation in scientific and academic publishing
    • Read the Docs open source philosophy
    • Read the Docs 團隊
    • Site support
    • Glossary
  • 開發者文件
  • Read the Docs 網站
Read the Docs user documentation
  • 關於 Read the Docs
  • Policies and legal documents
  • Edit on GitHub

Policies and legal documents

Here is some of the fine print used by Read the Docs Community and Read the Docs for Business:

Abandoned projects policy

Our policy of taking action on abandoned projects.

Unofficial and unmaintained projects policy

Our policy of taking action on unofficial and unmaintained projects.

Terms of Service

The terms of service for using Read the Docs Community and Read the Docs for Business. You may instead have a master services agreement for your subscription if you have a custom or enterprise contract.

Privacy Policy

Our policy on collecting, storing, and protecting user and visitor data.

Security policy

Our policies around application and infrastructure security.

Security reports

How we respond to security incidents and how you report a security issue.

Data Processing Addendum (DPA)

For GDPR and CCPA compliance, we provide a data processing addendum for Read the Docs for Business customers.

DMCA takedown policy

Our process for taking down content based on DMCA requests and how to submit requests.

Previous Next

© Copyright Read the Docs, Inc & contributors.

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