readthedocs.io

Loading...

Loading...

{
  "latency": 57,
  "ipAddresses": [
    "104.16.253.120",
    "104.16.254.120",
    "2606:4700::6810:fd78",
    "2606:4700::6810:fe78"
  ],
  "dns": {
    "NS": [
      "ivan.ns.cloudflare.com.",
      "tegan.ns.cloudflare.com."
    ],
    "A": [
      "104.16.253.120",
      "104.16.254.120"
    ],
    "AAAA": [
      "2606:4700::6810:fd78",
      "2606:4700::6810:fe78"
    ]
  }
}

[
  {
    "url": "https://readthedocs.io",
    "technologies": [
      {
        "slug": "lit-html",
        "name": "lit-html",
        "versions": [
          "3.1.2"
        ],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "Lit.svg",
        "categories": [
          {
            "id": 59,
            "slug": "javascript-libraries",
            "name": "JavaScript libraries"
          }
        ]
      },
      {
        "slug": "rss",
        "name": "RSS",
        "versions": [],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "RSS.svg",
        "categories": [
          {
            "id": 19,
            "slug": "miscellaneous",
            "name": "Miscellaneous"
          }
        ]
      },
      {
        "slug": "amazon-web-services",
        "name": "Amazon Web Services",
        "versions": [],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "Amazon Web Services.svg",
        "categories": [
          {
            "id": 62,
            "slug": "paas",
            "name": "PaaS"
          }
        ]
      },
      {
        "slug": "open-graph",
        "name": "Open Graph",
        "versions": [],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "Open Graph.svg",
        "categories": [
          {
            "id": 19,
            "slug": "miscellaneous",
            "name": "Miscellaneous"
          }
        ]
      },
      {
        "slug": "google-workspace",
        "name": "Google Workspace",
        "versions": [],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "Google.svg",
        "categories": [
          {
            "id": 30,
            "slug": "webmail",
            "name": "Webmail"
          },
          {
            "id": 75,
            "slug": "email",
            "name": "Email"
          }
        ]
      },
      {
        "slug": "lit-element",
        "name": "lit-element",
        "versions": [
          "4.0.4"
        ],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "Lit.svg",
        "categories": [
          {
            "id": 59,
            "slug": "javascript-libraries",
            "name": "JavaScript libraries"
          }
        ]
      },
      {
        "slug": "jquery",
        "name": "jQuery",
        "cpe": "cpe:2.3:a:jquery:jquery:3.6.0:*:*:*:*:*:*:*",
        "versions": [
          "3.6.0"
        ],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "jQuery.svg",
        "categories": [
          {
            "id": 59,
            "slug": "javascript-libraries",
            "name": "JavaScript libraries"
          }
        ]
      },
      {
        "slug": "font-awesome",
        "name": "Font Awesome",
        "versions": [],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "Font Awesome.svg",
        "categories": [
          {
            "id": 17,
            "slug": "font-scripts",
            "name": "Font scripts"
          }
        ]
      },
      {
        "slug": "webpack",
        "name": "Webpack",
        "versions": [],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "Webpack.svg",
        "categories": [
          {
            "id": 19,
            "slug": "miscellaneous",
            "name": "Miscellaneous"
          }
        ]
      },
      {
        "slug": "cloudflare",
        "name": "Cloudflare",
        "versions": [],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "CloudFlare.svg",
        "categories": [
          {
            "id": 31,
            "slug": "cdn",
            "name": "CDN"
          }
        ]
      },
      {
        "slug": "http-3",
        "name": "HTTP/3",
        "versions": [],
        "trafficRank": 0,
        "confirmedAt": 1722594732,
        "icon": "HTTP3.svg",
        "categories": [
          {
            "id": 19,
            "slug": "miscellaneous",
            "name": "Miscellaneous"
          }
        ]
      }
    ]
  }
]

{
  "Google Analytics": "Google Analytics offers a host of compelling features and benefits for everyone from senior executives and advertising and marketing professionals to site owners and content developers.",
  "Google Analytics Classic": "Classic Google Analytics - sites that are using non-universal analytics code.",
  "Google Universal Analytics": "The analytics.js JavaScript snippet is a new way to measure how users interact with your website. It is similar to the previous Google tracking code, ga.js, but offers more flexibility for developers to customize their implementations.",
  "Global Site Tag": "Google's primary tag for Google Measurement/Conversion Tracking, Adwords and DoubleClick.",
  "Google Tag Manager": "Tag management that lets you add and update website tags without changes to underlying website code.",
  "Cloudflare Radar": "The website appears on the Cloudflare Radar Top 1m sites list",
  "Cloudflare Radar Top 50k": "The website appears in the Cloudflare Radar Top 50,000.",
  "Font Awesome": "Iconic font and CSS toolkit.",
  "US Privacy User Signal Mechanism": "The US Privacy API (USP API) is a lightweight API used to communicate signals represented in the US Privacy String.",
  "Cloudflare": "Automatically optimizes the delivery of your web pages so your visitors get the fastest page load times and best performance.",
  "Viewport Meta": "This page uses the viewport meta tag which means the content may be optimized for mobile content.",
  "IPhone / Mobile Compatible": "The website contains code that allows the page to support IPhone / Mobile Content.",
  "jQuery": "JQuery is a fast, concise, JavaScript Library that simplifies how you traverse HTML documents, handle events, perform animations, and add Ajax interactions to your web pages. jQuery is designed to change the way that you write JavaScript.",
  "es6 promise": "A polyfill for ES6-style Promises.",
  "EthicalAds": "Privacy-focused advertising.",
  "GitHub": "The website mentions github.com in some form.",
  "Twitter": "The website mentions twitter.com in some form.",
  "Many Subdomains": "This domain has at least 1000 subdomains that resolve to an IP address.",
  "Cloudflare Hosting": "Supercharged web hosting service.",
  "Google Apps for Business": "Web-based email, calendar, and documents for teams. Renamed to Google Apps for Work, but now known as G Suite from Google Cloud.",
  "Cloudflare DNS": "DNS services provided by Cloudflare.",
  "SSL by Default": "The website redirects traffic to an HTTPS/SSL version by default.",
  "nginx": "nginx [engine x] is a HTTP server and mail proxy server written by Igor Sysoev.",
  "IPv6": "The website has an IPv6 record."
}

<!DOCTYPE html>
<html lang="en">

<head>
    <title>Full featured documentation deployment platform - Read the Docs</title>
    <meta charset="utf-8" />
    <meta name="generator" content="Pelican" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <meta property="og:site_name" content="Read the Docs" />
    <meta property="og:type" content="article" />
    <meta property="og:title" content="Full featured documentation deployment platform" />
    <meta property="twitter:title" content="Full featured documentation deployment platform" />
    <meta name="description" content="Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more." />
    <meta property="og:description" content="Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more." />
    <meta property="twitter:description" content="Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more." />
    <meta property="og:image" content="/images/logo-opengraph.png" />
    <meta property="twitter:image" content="/images/logo-opengraph.png" />
    <meta name="author" content="Read the Docs, Inc" />


    <link rel="apple-touch-icon" sizes="180x180" href="https://about.readthedocs.com/theme/img/apple-touch-icon.png">
    <link rel="icon" type="image/png" sizes="32x32" href="https://about.readthedocs.com/theme/img/favicon-32x32.png">
    <link rel="icon" type="image/png" sizes="24x24" href="https://about.readthedocs.com/theme/img/favicon-24x24.png">
    <link rel="icon" type="image/png" sizes="16x16" href="https://about.readthedocs.com/theme/img/favicon-16x16.png">
    <link rel="shortcut icon" href="https://about.readthedocs.com/theme/img/favicon.ico">

    <link href="https://about.readthedocs.com//feeds/atom.xml" type="application/atom+xml" rel="alternate" title="Read the Docs Atom Feed" />

    <link rel="stylesheet" type="text/css" href="https://about.readthedocs.com/theme/css/site.css" />
    <script src="https://kit.fontawesome.com/53af4251af.js" crossorigin="anonymous"></script>

    <script src="https://about.readthedocs.com/theme/js/vendor.js"></script>
    <script src="https://about.readthedocs.com/theme/js/site.js"></script>
<script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="readthedocs-about" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head>

<body>



<div class="ui basic fitted attached segment">
  <div class="ui container">
    <div class="ui middle aligned grid">

        <div class="four wide computer five wide tablet eleven wide mobile left aligned column">
          <div class="ui horizontally fitted basic segment">
            <a href="https://about.readthedocs.com/" aria-label="Read the Docs homepage">
              <img class="ui image" src="https://about.readthedocs.com/theme/img/logo-wordmark-dark.svg" width="220" alt="Read the Docs logo"/>
            </a>
          </div>
        </div>

        <div class="five wide mobile only right aligned column">
          <div class="ui wide dropdown" data-module="dropdown" data-action="select">
            <i class="fad fa-bars large icon" style="--fa-secondary-opacity: 0.8;"></i>
            <div class="menu">

                <div class="header">Log in</div>
  <a class="item" data-analytics="community-login" href="https://app.readthedocs.org/dashboard/">
    <i class="fad fa-people-group primary icon"></i>
    Read the Docs Community

    <p class="ui mini grey text">
      <code>https://readthedocs.org</code>
    </p>
  </a>
  <a class="item" data-analytics="commercial-login" href="https://app.readthedocs.com/dashboard/">
    <i class="fad fa-building secondary icon"></i>
    Read the Docs Business

    <p class="ui mini grey text">
      <code>https://readthedocs.com</code>
    </p>
  </a>
    <a class="item"
      data-analytics="signup-modal"
      onclick="jQuery('#signup-modal').modal('show');">
      <i class="fas fa-plus primary icon"></i>
      Sign up
    </a>

  <a class="item" href="/choosing-a-platform/">
    <i class="fad fa-circle-question grey icon"></i>
    Choosing a platform
  </a>

              <div class="divider"></div>
              <a class="item" href="https://about.readthedocs.com/features/">
                <i class="fad fa-arrow-progress primary icon"></i>
                Product
              </a>
              <div class="divider"></div>
                <div class="header">Plans</div>
  <a class="item" href="https://about.readthedocs.com/pricing/#/business">
    <i class="fad fa-diagram-venn primary icon"></i>
    Business plans
  </a>
  <a class="item" href="https://about.readthedocs.com/pricing/#/community">
    <i class="fad fa-diagram-venn primary icon"></i>
    Community plans
  </a>
  <a class="item" href="https://about.readthedocs.com/pricing/enterprise/">
    <i class="fad fa-briefcase primary icon"></i>
    Enterprise plans
  </a>

              <div class="divider"></div>
              
  <div class="header">Updates</div>
  <a class="item" href="https://about.readthedocs.com/blog/">
    <i class="fad fa-newspaper fa-swap-opacity primary icon"></i>
    Blog
  </a>

  <div class="header">Help</div>
  <a class="item" href="http://status.readthedocs.com" target="_blank">
        <i class="fad fa-circle-check fa-swap-opacity primary icon"></i>
        Status
        <span class="description">
          <i class="fad fa-external-link icon"></i>
        </span>
  </a>

  <a class="item" href="https://docs.readthedocs.io/page/support.html" target="_blank">
    <i class="fad fa-envelope primary icon"></i>
    Support
    <span class="description">
      <i class="fad fa-external-link icon"></i>
    </span>
  </a>
  <a class="item" href="https://docs.readthedocs.io" target="_blank">
    <i class="fad fa-book primary icon"></i>
    Documentation
    <span class="description">
      <i class="fad fa-external-link icon"></i>
    </span>
  </a>
  <a class="item" href="https://docs.readthedocs.io/page/tutorial/" target="_blank">
    <i class="fad fa-rocket primary icon"></i>
    Tutorial
    <span class="description">
      <i class="fad fa-external-link icon"></i>
    </span>
  </a>



            </div>
          </div>
        </div>

        <div class="twelve wide computer eleven wide tablet left aligned tablet only computer only column">
          <div class="ui big borderless secondary menu">

            <a class="item" href="https://about.readthedocs.com/features/">
              Product
            </a>

            <div
                class="ui wide dropdown item"
                data-module="dropdown"
                data-module-on="hover">

              Pricing
              <i class="dropdown fad fa-caret-down icon"></i>

              <div class="menu">
                  <div class="header">Plans</div>
  <a class="item" href="https://about.readthedocs.com/pricing/#/business">
    <i class="fad fa-diagram-venn primary icon"></i>
    Business plans
  </a>
  <a class="item" href="https://about.readthedocs.com/pricing/#/community">
    <i class="fad fa-diagram-venn primary icon"></i>
    Community plans
  </a>
  <a class="item" href="https://about.readthedocs.com/pricing/enterprise/">
    <i class="fad fa-briefcase primary icon"></i>
    Enterprise plans
  </a>

              </div>
            </div>

            <div
                class="ui wide dropdown item"
                data-module="dropdown"
                data-module-on="hover">

              Resources
              <i class="dropdown fad fa-caret-down icon"></i>

              <div class="menu">
                
  <div class="header">Updates</div>
  <a class="item" href="https://about.readthedocs.com/blog/">
    <i class="fad fa-newspaper fa-swap-opacity primary icon"></i>
    Blog
  </a>

  <div class="header">Help</div>
  <a class="item" href="http://status.readthedocs.com" target="_blank">
        <i class="fad fa-circle-check fa-swap-opacity primary icon"></i>
        Status
        <span class="description">
          <i class="fad fa-external-link icon"></i>
        </span>
  </a>

  <a class="item" href="https://docs.readthedocs.io/page/support.html" target="_blank">
    <i class="fad fa-envelope primary icon"></i>
    Support
    <span class="description">
      <i class="fad fa-external-link icon"></i>
    </span>
  </a>
  <a class="item" href="https://docs.readthedocs.io" target="_blank">
    <i class="fad fa-book primary icon"></i>
    Documentation
    <span class="description">
      <i class="fad fa-external-link icon"></i>
    </span>
  </a>
  <a class="item" href="https://docs.readthedocs.io/page/tutorial/" target="_blank">
    <i class="fad fa-rocket primary icon"></i>
    Tutorial
    <span class="description">
      <i class="fad fa-external-link icon"></i>
    </span>
  </a>


              </div>
            </div>

            <div class="right menu">

              <div class="item">
                <div class="ui floating top right pointing dropdown" data-module="dropdown" data-action="select" data-display-type="block">
                  <a class="ui">
                    Log in
                  </a>
                  <div class="menu">
                      <div class="header">Log in</div>
  <a class="item" data-analytics="community-login" href="https://app.readthedocs.org/dashboard/">
    <i class="fad fa-people-group primary icon"></i>
    Read the Docs Community

    <p class="ui mini grey text">
      <code>https://readthedocs.org</code>
    </p>
  </a>
  <a class="item" data-analytics="commercial-login" href="https://app.readthedocs.com/dashboard/">
    <i class="fad fa-building secondary icon"></i>
    Read the Docs Business

    <p class="ui mini grey text">
      <code>https://readthedocs.com</code>
    </p>
  </a>

  <a class="item" href="/choosing-a-platform/">
    <i class="fad fa-circle-question grey icon"></i>
    Choosing a platform
  </a>

                  </div>
                </div>
              </div>

              <div class="item">
                <a class="ui button"
                   data-analytics="signup-modal"
                   onclick="jQuery('#signup-modal').modal('show');">
                  Sign up
                </a>
              </div>

            </div>
          </div>
        </div>

    </div>
  </div>
</div>


<div class="ui modal"
       id="signup-modal"
       data-module="modal"
       data-inverted="true">
    <div class="header">Get started with Read the Docs</div>
    <div class="content">
      <div class="ui center aligned basic fitted segment">
        <p>
          Which site best fits your project?
        </p>
      </div>

      <div class="ui stacking centered grid">
        <div class="stretched row">

          <div class="seven wide computer sixteen wide tablet column">
            <div class="ui raised segment">
              <div class="ui header">
                Read the Docs Community
                <div class="sub header">
                  For free and open-source projects
                </div>
              </div>

              <div class="ui relaxed list">
                <div class="item">
                  <i class="fad fa-lock-open primary icon"></i>
                  Clone public repositories
                </div>
                <div class="item">
                  <i class="fad fa-eye primary icon"></i>
                  Public documentation
                </div>
                <div class="item">
                  <i class="fad fa-rectangle-ad primary icon"></i>
                  Ads supported hosting
                </div>
              </div>

              <div class="ui center aligned basic fitted segment">
                <p>
                  <b>Free</b> for open-source software.
                </p>

                <a class="ui primary center aligned button"
                  data-analytics="community-signup"
                   href="https://app.readthedocs.org/accounts/signup/">
                  Sign up
                </a>
              </div>
            </div>
          </div>

          <div class="seven wide computer sixteen wide tablet column">
            <div class="ui raised segment">
              <div class="ui header">
                Read the Docs Business
                <div class="sub header">
                  For commercial and non-free projects
                </div>
              </div>

              <div class="ui relaxed list">
                <div class="item">
                  <i class="fad fa-lock-keyhole primary icon"></i>
                  Clone private and public repositories
                </div>
                <div class="item">
                  <i class="fad fa-eye-slash primary icon"></i>
                  Public and private documentation
                </div>
                <div class="item">
                  <i class="fad fa-users primary icon"></i>
                  Team management for your organization
                </div>
              </div>

              <div class="ui center aligned basic fitted segment">
                <p>
                  Plans starting at <b>$50/month</b>.
                </p>

                <a class="ui primary center aligned button"
                  data-analytics="commercial-signup"
                   href="https://app.readthedocs.com/accounts/signup/">
                  Sign up
                </a>
              </div>
            </div>
          </div>

        </div>
      </div>

    </div>

    <div class="actions">
      <a href="/choosing-a-platform/" class="ui cancel button"><i class="fad fa-circle-question grey icon" aria-hidden="true"></i>Choosing a platform</a>
      <a href="/features/" class="ui cancel button"><i class="fad fa-sparkles grey icon" aria-hidden="true"></i>Explore all the features</a>
    </div>
  </div>

  <main>  



      <section>
        <div class="ui padded hero container">
          <div class="ui relaxed grid centered middle aligned">
            <div class="row">

                <div class="seven wide computer twelve wide tablet sixteen wide mobile column">
                  <div class="ui large left aligned basic vertical segment">
                  <h1 class="ui huge header">
                    Docs as Code for everyone
                  </h1>
                  <p>
                    Empower your team with versioned documentation, seamless previews, and powerful authentication. All integrated into your Git workflow.
                  </p>

                    <a class="ui large teal stackable button" data-analytics="signup-modal" onclick="jQuery('#signup-modal').modal('show');">
                    <i class="fad fa-play icon"></i>
                    Get started for free
                    </a>
                    <a href="/features/" class="ui large secondary stackable basic button">
                    <i class="fad fa-sparkles icon"></i>
                    Explore features
                    </a>

                  </div>
                </div>

                <div class="column eight wide computer only">
                  <div class="ui basic segment">
                    <img class="ui image fluid" src="/images/homepage.png" alt="A terminal executing Git commands to build multiple versions of documentation" />
                  </div>
                </div>

            </div>
          </div>
        </div>
      </section>

  <div class="ui very padded wide container">
    <div class="ui padded relaxed stretched stackable centered grid">
      
  <div class="five wide computer twelve wide tablet left aligned column">
    <div class="ui inverted grey stacked very padded large segment">
      <i class="fad white fa-user-robot big shadowed icon" style="--fa-secondary-color: skyblue; --fa-secondary-opacity: 1.0"></i>

      <h2 class="ui small left aligned monospace header">
        Automatic deploy previews
      </h2>

                <p>
            Preview your documentation on every pull request.
            Never guess what you're shipping again.
          </p>


    </div>
  </div>

  <div class="five wide computer twelve wide tablet left aligned column">
    <div class="ui inverted black stacked very padded large segment">
      <i class="fad olive fa-terminal big shadowed icon"></i>

      <h2 class="ui small left aligned monospace header">
        Ideal developer experience
      </h2>

              <p class="small">
          Write documentation with Git and your favorite text editor.
          Developers and writers both love <strong>docs as code</strong>.
        </p>


    </div>
  </div>

  <div class="five wide computer twelve wide tablet left aligned column">
    <div class="ui inverted violet stacked very padded large segment">
      <i class="fad white fa-key-skeleton big shadowed icon" style="--fa-secondary-color: orangered; --fa-secondary-opacity: 1.0"></i>

      <h2 class="ui small left aligned monospace header">
        Work privately or publicly
      </h2>

                <p>
            Share content with just your team, or with the whole world.
            Sync permissions from GitHub, or manage custom permissions for your projects.
          </p>


    </div>
  </div>

    </div>
  </div>

<section id="business-logo">
    <div class="ui very padded container">
        <h3 class="ui huge center aligned header">
            Trusted by businesses worldwide since 2010
        </h3>
        <div class="ui padded stackable four column grid">
            <div class="middle aligned center aligned column">
                <img class="ui small inline image" src="/images/amd-logo.svg" alt="AMD logo">
            </div>
            <div class="middle aligned center aligned column">
                <img class="ui small inline image" src="/images/canonical-logo.svg" alt="Canonical logo">
            </div>
            <div class="middle aligned center aligned column">
                <img class="ui small inline image" src="/images/anaconda-logo.svg" alt="Anaconda logo">
            </div>
            <div class="middle aligned center aligned column">
                <img class="ui small inline image" src="/images/acquia-logo.svg" alt="Acquia logo">
            </div>
        </div>
    </div>
</section>

    <div class="ui divider"></div>

      <section id="features">
        <div class="ui very padded container">

          <h3 class="ui large monospace header">
            Features
          </h3>

          <div class="ui centered vertically padded container stackable grid">

  <div class="sixteen wide mobile eight wide tablet five wide computer column">
    <div class="ui padded grid">
      <div class="three wide computer two wide tablet three wide mobile right aligned column">
        <i class="fad fa-terminal big teal icon"></i>
      </div>
      <div class="thirteen wide computer fourteen wide tablet thirteen wide mobile left aligned column">
        <h3 class="ui small header">
          Supports any doc tool
        </h3>
        <p>
                        Integrated support for <strong><a href="/tools/sphinx/">Sphinx</a></strong>, <strong><a href="/tools/mkdocs/">MkDocs</a></strong>, <strong><a href="/tools/jupyter-book/">Jupyter Book</a></strong>.
              Flexible enough to work with any documentation tool.

        </p>
      </div>
    </div>
  </div>

  <div class="sixteen wide mobile eight wide tablet five wide computer column">
    <div class="ui padded grid">
      <div class="three wide computer two wide tablet three wide mobile right aligned column">
        <i class="fad fa-search big teal icon"></i>
      </div>
      <div class="thirteen wide computer fourteen wide tablet thirteen wide mobile left aligned column">
        <h3 class="ui small header">
          Integrated search
        </h3>
        <p>
                        Easily search all your docs via our dashboard,
              and offer your users a more powerful search with our  search API.

        </p>
      </div>
    </div>
  </div>

  <div class="sixteen wide mobile eight wide tablet five wide computer column">
    <div class="ui padded grid">
      <div class="three wide computer two wide tablet three wide mobile right aligned column">
        <i class="fad fa-code-compare big teal icon"></i>
      </div>
      <div class="thirteen wide computer fourteen wide tablet thirteen wide mobile left aligned column">
        <h3 class="ui small header">
          Pull request previews
        </h3>
        <p>
                        Preview each pull request before releasing any changes,
              allowing for fast collaboration across your organization.

        </p>
      </div>
    </div>
  </div>

  <div class="sixteen wide mobile eight wide tablet five wide computer column">
    <div class="ui padded grid">
      <div class="three wide computer two wide tablet three wide mobile right aligned column">
        <i class="fad fa-layer-group big teal icon"></i>
      </div>
      <div class="thirteen wide computer fourteen wide tablet thirteen wide mobile left aligned column">
        <h3 class="ui small header">
          Versioned docs
        </h3>
        <p>
                        Match your product release cycle with multiple versions of your docs. Automatically build versions from any branch or tag.

        </p>
      </div>
    </div>
  </div>

  <div class="sixteen wide mobile eight wide tablet five wide computer column">
    <div class="ui padded grid">
      <div class="three wide computer two wide tablet three wide mobile right aligned column">
        <i class="fad fa-lock big teal icon"></i>
      </div>
      <div class="thirteen wide computer fourteen wide tablet thirteen wide mobile left aligned column">
        <h3 class="ui small header">
          Private repository support
          <span class="sub header">
            <i class="fad fa-square-dollar violet icon"></i>
            <span class="ui violet text">Paid plan feature</span>
          </span>
        </h3>
        <p>
                        Clone private repositories using a connected GitHub, GitLab, or Bitbucket account,
              or clone from any Git provider with an SSH key.

        </p>
      </div>
    </div>
  </div>

  <div class="sixteen wide mobile eight wide tablet five wide computer column">
    <div class="ui padded grid">
      <div class="three wide computer two wide tablet three wide mobile right aligned column">
        <i class="fad fa-fingerprint big teal icon"></i>
      </div>
      <div class="thirteen wide computer fourteen wide tablet thirteen wide mobile left aligned column">
        <h3 class="ui small header">
          Single-Sign On
          <span class="sub header">
            <i class="fad fa-square-dollar violet icon"></i>
            <span class="ui violet text">Paid plan feature</span>
          </span>
        </h3>
        <p>
                        Control who has access to your documentation with integrated authentication.
              Enable <strong>SSO with GitHub or GitLab</strong> to easily manage permissions in one place.

        </p>
      </div>
    </div>
  </div>

              <div class="ten wide computer sixteen wide tablet center aligned column">
                <div class="ui basic padded vertical segment">

                <a href="/features/" class="ui large secondary relaxed button">
                  Discover all our features
                  <i class="fad fa-sparkles"></i>
                </a>
                </div>

              </div>

          </div>
        </div>
      </section>

<div class="ui container">
    <div class="ui horizontal divider">Try it out</div>
</div>

<section id="try-it-out">
    <div class="ui padded container">
      <h2 class="ui huge center aligned header">
        Upgrade your documentation with Read the Docs
      </h2>
  
      <div class="ui very padded centered grid">
  
        <div class="ten wide computer sixteen wide tablet sixteen wide mobile column">
          <div class="ui large left aligned basic vertical segment">
  
  <div class="ui inverted padded segment">
    <div class="ui top attached label">
        <i class="fad fa-file icon"></i>
      <code>.readthedocs.yaml</code>
    </div>
    <div class="highlight"><pre><span></span><code><span class="nt">version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span>
<span class="nt">build</span><span class="p">:</span>
<span class="w">  </span><span class="nt">os</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu-22.04</span>
<span class="w">  </span><span class="nt">tools</span><span class="p">:</span>
<span class="w">    </span><span class="nt">python</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;3.10&quot;</span>
<span class="w">    </span><span class="c1"># You can also specify other tool versions:</span>
<span class="w">    </span><span class="c1"># nodejs: &quot;16&quot;</span>

<span class="c1"># Build documentation in the docs/ directory with Sphinx</span>
<span class="nt">sphinx</span><span class="p">:</span>
<span class="w">   </span><span class="nt">configuration</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docs/conf.py</span>

<span class="c1"># Dependencies required to build your docs</span>
<span class="nt">python</span><span class="p">:</span>
<span class="w">   </span><span class="nt">install</span><span class="p">:</span>
<span class="w">   </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">requirements</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">docs/requirements.txt</span>
</code></pre></div>
  </div>
          </div>
        </div>
  
        <div class="middle aligned left aligned six wide computer twelve wide tablet sixteen wide mobile column">
          <div class="ui padded basic segment">
            <div class="ui relaxed list"><span class="ui small teal header item">
                <i class="fad fa-square-1 secondary big icon"></i>
                <span class="content">
                  Create an account
                  <span class="sub header">
                    <a data-analytics="signup-modal" onclick="jQuery('#signup-modal').modal('show');">
                      Sign up
                    </a>
                    with GitHub or your email.
                  </span>
                </span>
              </span><span class="ui small header item">
                <i class="fad fa-square-2 secondary big icon"></i>
                <span class="content">
                  Import your project
                  <span class="sub header">Select your existing Git repositories with a 1-click interface.</span>
                </span>
              </span><span class="ui small header item">
                <i class="fad fa-square-3 secondary big icon"></i>
                <span class="content">
                  Add YAML config
                  <span class="sub header">Copy this example, it probably does what you want 😉</span>
                </span>
              </span><span class="ui small header item">
                <i class="fad fa-square-4 secondary big icon"></i>
                <span class="content">
                  Your docs build on every commit
                  <span class="sub header">Like magic.</span>
                </span>
              </span>
            </div>
          </div>
        </div>
  
      </div>
    </div>
</section>

<section id="testimonials">
    <div class="ui container">
      <div class="ui basic very padded vertical segment">
    <h3 class="ui large header">
      <i class="fad purple fa-message-lines icon" style="--fa-secondary-color: blueviolet;"></i>
      <span class="content">
        Join thousands of happy users
      </span>
    </h3>
  </div>

    <div class="ui three link stackable cards">
        <a href="https://flask.palletsprojects.com/" class="card">
        <div class="content">
            <div class="ui center aligned basic segment">
            <img class="ui small image" src="/images/flask-logo.png" alt="Flask logo" />
            </div>
            <div class="header">Flask</div>
            <div class="meta">
            Web Framework
            </div>
            <div class="description">
            Flask is a Python web framework built with a small core and easy-to-extend philosophy.
            </div>
        </div>
        </a>

        <a href="https://docs.jupyter.org/" class="card">
        <div class="content">
            <div class="ui center aligned basic segment">
            <img class="ui small image" src="/images/jupyter-logo.png" alt="Jupyter logo">
            </div>
            <div class="header">Jupyter</div>
            <div class="meta">
            Data Science Environment
            </div>
            <div class="description">
            Jupyter Notebook is a web-based interactive computational environment for creating notebook documents.
            </div>
        </div>
        </a>

        <a href="https://docs.godotengine.org/" class="card">
        <div class="content">
            <div class="ui center aligned basic segment">
            <img class="ui small image" src="/images/godot-logo.png" alt="Godot Engine logo">
            </div>
            <div class="header">Godot Engine</div>
            <div class="meta">
            Game Engine
            </div>
            <div class="description">
            Godot Engine is a free and open source community-driven 2D and 3D game engine.
            </div>
        </div>
        </a>
    </div>
    </div>
</section>
    <section>
      <div class="ui very padded container">
        <div class="ui stackable equal width grid">
          <div class="stretched row">
            <div class="column">
              <div class="ui very padded raised large segment">
  <i class="fad fa-quotes big icon"></i>
  <blockquote class="ui big text">
                      Read the Docs is a solid documentation hosting platform that is used all over the place and has some nice features on top of being FOSS software.

  </blockquote>

  <div class="ui small header">
      <a href="https://github.com/hydrologie/xdatasets/issues/32#issue-2019390201" target="_blank" rel="noopener">
    <img src="https://github.com/Zeitsperre.png" class="ui avatar image" alt="Trevor James Smith, Developer, Ouranos" />
    <div class="content">
      Trevor James Smith
      <div class="sub header">
        Developer, <i>Ouranos</i>
      </div>
    </div>
        </a>
  </div>
              </div>
            </div>

            <div class="column">
              <div class="ui very padded raised large segment">
  <i class="fad fa-quotes big icon"></i>
  <blockquote class="ui big text">
                      The documentation is now easier to navigate, thanks to a new top navigation bar and a search-as-you-type modal courtesy of Read the Docs. Snappy docs are happy docs!

  </blockquote>

  <div class="ui small header">
      <a href="https://fosstodon.org/@[email protected]/111608164611739960" target="_blank" rel="noopener">
    <img src="https://github.com/astrojuanlu.png" class="ui avatar image" alt="Juan Luis Cano Rodríguez, Developer Advocate, Kedro" />
    <div class="content">
      Juan Luis Cano Rodríguez
      <div class="sub header">
        Developer Advocate, <i>Kedro</i>
      </div>
    </div>
        </a>
  </div>
              </div>
            </div>
          </div>
        </div>
      </div>
    </section>

    <section>
      <div class="ui very padded container">
        <div class="ui grid center aligned">

          <div class="row">
            <div class="column twelve wide computer sixteen wide tablet">

              <div class="ui basic vertical huge segment">
                <p>
                  <b>Get your docs online in 5 minutes.</b>
                </p>

                <p>
                  <a class="ui large teal stackable button" data-analytics="signup-modal" onclick="jQuery('#signup-modal').modal('show');">
                  <i class="fad fa-play icon"></i>
                  Create an account
                </a>
                </p>
              </div>

            </div>
          </div>

        </div>
      </div>
    </section>

  
</main>

<footer class="ui basic very padded inverted attached segment">
  <div class="ui container">

      <div class="ui four column stackable grid very padded">

        <div class="column">
          <div class="ui vertical inverted text menu">
              <h4 class="ui sub header">Stay updated</h4>
              <a class="item" href="https://about.readthedocs.org/blog/">Blog</a>
              <a class="item" href="https://landing.mailerlite.com/webforms/landing/t0a9l4">Newsletter</a>
              <a class="item" href="https://status.readthedocs.com/">Status</a>
              <div class="item">
                <a href="https://github.com/readthedocs/" aria-label="Read the Docs on GitHub" rel="noopener noreferrer"><i class="icon large fab fa-github"></i></a>
                <a href="https://twitter.com/readthedocs" aria-label="Read the Docs on Twitter" rel="noopener noreferrer"><i class="icon large fab fa-twitter"></i></a>
                <a href="https://fosstodon.org/@readthedocs" aria-label="Read the Docs on Mastodon / Fediverse" rel="me"><i class="icon large fab fa-mastodon"></i></a>
              </div>
          </div>
        </div>

        <div class="column">
          <div class="ui vertical inverted text menu">
              <h4 class="ui sub header">Learn more</h4>
              <a class="item" href="https://docs.readthedocs.io">Documentation</a>
              <a class="item" href="https://docs.readthedocs.io/page/tutorial/index.html">Tutorial</a>
              <a class="item" href="https://docs.readthedocs.io/page/config-file/index.html">Configure your project</a>
              <a class="item" href="/tools/">Popular documentation tools</a>
              <a class="item" href="/comparisons/">Compare to other platforms</a>
          </div>
        </div>

        <div class="column">
          <div class="ui vertical inverted text menu">
              <h4 class="ui sub header">Product</h4>
              <a class="item" href="/features/">Features</a>
              <a class="item" href="/pricing/">Pricing</a>
              <a class="item" href="/privacy-policy">Privacy Policy</a>
              <a class="item" href="/terms-of-service/">Terms of Service</a>
          </div>
        </div>

        <div class="column">
          <div class="ui vertical inverted text menu">
              <h4 class="ui sub header">Company</h4>
              <a class="item" href="/company/">About us</a>
              <a class="item" href="https://docs.readthedocs.com/platform/stable/support.html">Support</a>
              <a class="item" href="https://www.ethicalads.io/advertisers/?ref=rtd">Advertise with Us</a>
              <a class="item" href="https://dev.readthedocs.io/page/contribute.html">Contribute</a>

          </div>
        </div>

      </div>

      <div class="ui basic center aligned inverted segment">
        <i class="fad fa-copyright icon"></i>
        Copyright 2025, Read the Docs, Inc &amp; contributors
      </div>


  </div>
</footer></body>
</html>

{
  "error": false,
  "result": {
    "success": true,
    "ogSiteName": "Read the Docs",
    "ogType": "article",
    "ogTitle": "Full featured documentation deployment platform",
    "twitterTitle": "Full featured documentation deployment platform",
    "ogDescription": "Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more.",
    "twitterDescription": "Read the Docs is a documentation building and hosting platform aimed at helping developers creating documentation from code with versioned documentation, integrated search, pull request previews and more.",
    "author": "Read the Docs, Inc",
    "ogImage": [
      {
        "url": "/images/logo-opengraph.png",
        "type": "png"
      }
    ],
    "twitterImage": [
      {
        "url": "/images/logo-opengraph.png"
      }
    ],
    "ogLocale": "en",
    "favicon": "https://about.readthedocs.com/theme/img/favicon.ico",
    "charset": "utf-8",
    "requestUrl": "https://readthedocs.io"
  },
  "response": {}
}

{
  "status": 200,
  "statusText": "",
  "headers": {
    "access-control-allow-methods": "HEAD, OPTIONS, GET",
    "access-control-allow-origin": "*",
    "age": "6469",
    "alt-svc": "h3=\":443\"; ma=86400",
    "cache-control": "max-age=1200",
    "cdn-cache-control": "public",
    "cf-cache-status": "HIT",
    "cf-ray": "9580c8ce2e34d62c-IAD",
    "connection": "keep-alive",
    "content-encoding": "gzip",
    "content-type": "text/html; charset=utf-8",
    "date": "Mon, 30 Jun 2025 21:33:51 GMT",
    "etag": "W/\"88a7fa47b322fe8acecaf4408b3a1dbf\"",
    "last-modified": "Thu, 26 Jun 2025 05:56:21 GMT",
    "referrer-policy": "no-referrer-when-downgrade",
    "server": "cloudflare",
    "transfer-encoding": "chunked",
    "vary": "Accept-Encoding",
    "x-amz-id-2": "5t3ac7zmDr81B4PvAug4ovC975v+nxEVioCI479PkbPyglGR3SoSOXhkYv9OQCFCkEfqoewcOZUB5ntPydUBM/UzvxXzl/pVTod8d9zJ6zE=",
    "x-amz-meta-mtime": "1750917375.403517008",
    "x-amz-request-id": "7P0HCHVRTQG9YXBZ",
    "x-amz-server-side-encryption": "AES256",
    "x-backend": "web-i-00d007ae6f1345138",
    "x-content-type-options": "nosniff",
    "x-rtd-domain": "about.readthedocs.com",
    "x-rtd-force-addons": "true",
    "x-rtd-path": "/proxito/html/readthedocs-about/latest/index.html",
    "x-rtd-project": "readthedocs-about",
    "x-rtd-project-method": "custom_domain",
    "x-rtd-resolver-filename": "/",
    "x-rtd-version": "latest",
    "x-rtd-version-method": "path",
    "x-served": "Nginx-Proxito-Sendfile",
    "set-cookie": "_cfuvid=BrYaR6ixvSMXRdySH9h828B0wq0OdOZyOZi0zuDOy_o-1751319231737-0.0.1.1-604800000; path=/; domain=.about.readthedocs.com; HttpOnly; Secure; SameSite=None"
  }
}

{
  "errors": [
    {
      "id": "authentication_failed",
      "code": 401,
      "details": "No user found for the API key supplied"
    }
  ]
}

{
  "whois.nic.io": {
    "Domain Status": [
      "clientTransferProhibited https://icann.org/epp#clientTransferProhibited"
    ],
    "Name Server": [
      "ivan.ns.cloudflare.com",
      "tegan.ns.cloudflare.com"
    ],
    "Domain Name": "readthedocs.io",
    "Registry Domain ID": "348a5e0e511740b9bcb9b9a16ed7c180-DONUTS",
    "Registrar WHOIS Server": "http://whois.cloudflare.com",
    "Registrar URL": "http://cloudflare.com",
    "Updated Date": "2025-06-28T09:41:10Z",
    "Created Date": "2014-06-14T19:58:22Z",
    "Expiry Date": "2028-06-14T19:58:22Z",
    "Registrar": "Cloudflare, Inc",
    "Registrar IANA ID": "1910",
    "Registrar Abuse Contact Email": "[email protected]",
    "Registrar Abuse Contact Phone": "",
    "Registry Registrant ID": "",
    "Registrant Name": "",
    "Registrant Organization": "",
    "Registrant Street": "",
    "Registrant City": "",
    "Registrant State/Province": "Oregon",
    "Registrant Postal Code": "",
    "Registrant Country": "US",
    "Registrant Phone": "",
    "Registrant Phone Ext": "",
    "Registrant Fax": "",
    "Registrant Fax Ext": "",
    "Registrant Email": "",
    "Registry Admin ID": "",
    "Admin Name": "",
    "Admin Organization": "",
    "Admin Street": "",
    "Admin City": "",
    "Admin State/Province": "",
    "Admin Postal Code": "",
    "Admin Country": "",
    "Admin Phone": "",
    "Admin Phone Ext": "",
    "Admin Fax": "",
    "Admin Fax Ext": "",
    "Admin Email": "",
    "Registry Tech ID": "",
    "Tech Name": "",
    "Tech Organization": "",
    "Tech Street": "",
    "Tech City": "",
    "Tech State/Province": "",
    "Tech Postal Code": "",
    "Tech Country": "",
    "Tech Phone": "",
    "Tech Phone Ext": "",
    "Tech Fax": "",
    "Tech Fax Ext": "",
    "Tech Email": "",
    "DNSSEC": "unsigned",
    "URL of the ICANN Whois Inaccuracy Complaint Form": "https://icann.org/wicf/",
    ">>> Last update of WHOIS database": "2025-06-30T21:33:51Z <<<",
    "text": [
      "For more information on Whois status codes, please visit https://icann.org/epp",
      "",
      "Terms of Use: Access to WHOIS information is provided to assist persons in determining the contents of a domain name registration record in the registry database. The data in this record is provided by Identity Digital or the Registry Operator for informational purposes only, and accuracy is not guaranteed. This service is intended only for query-based access. You agree that you will use this data only for lawful purposes and that, under no circumstances will you use this data to (a) allow, enable, or otherwise support the transmission by e-mail, telephone, or facsimile of mass unsolicited, commercial advertising or solicitations to entities other than the data recipient's own existing customers; or (b) enable high volume, automated, electronic processes that send queries or data to the systems of Registry Operator, a Registrar, or Identity Digital except as reasonably necessary to register domain names or modify existing registrations. When using the Whois service, please consider the following: The Whois service is not a replacement for standard EPP commands to the SRS service. Whois is not considered authoritative for registered domain objects. The Whois service may be scheduled for downtime during production or OT&E maintenance periods. Queries to the Whois services are throttled. If too many queries are received from a single IP address within a specified time, the service will begin to reject further queries for a period of time to prevent disruption of Whois service access. Abuse of the Whois system through data mining is mitigated by detecting and limiting bulk query access from single sources. Where applicable, the presence of a [Non-Public Data] tag indicates that such data is not made publicly available due to applicable data privacy laws or requirements. Should you wish to contact the registrant, please refer to the Whois records available through the registrar URL listed above. Access to non-public data may be provided, upon request, where it can be reasonably confirmed that the requester holds a specific legitimate interest and a proper legal basis for accessing the withheld data. Access to this data provided by Identity Digital can be requested by submitting a request via the form found at https://www.identity.digital/about/policies/whois-layered-access/. The Registrar of Record identified in this output may have an RDDS service that can be queried for additional information on how to contact the Registrant, Admin, or Tech contact of the queried domain name. Identity Digital Inc. and Registry Operator reserve the right to modify these terms at any time. By submitting this query, you agree to abide by this policy."
    ]
  },
  "whois.cloudflare.com": {
    "Domain Status": [
      "clienttransferprohibited https://icann.org/epp#clienttransferprohibited",
      "transferperiod https://icann.org/epp#transferperiod"
    ],
    "Name Server": [
      "ivan.ns.cloudflare.com",
      "tegan.ns.cloudflare.com"
    ],
    "Domain Name": "READTHEDOCS.IO",
    "Registry Domain ID": "348a5e0e511740b9bcb9b9a16ed7c180-DONUTS",
    "Registrar WHOIS Server": "whois.cloudflare.com",
    "Registrar URL": "https://www.cloudflare.com",
    "Updated Date": "2025-06-23T09:41:00Z",
    "Created Date": "2014-06-14T19:58:22Z",
    "Expiry Date": "2028-06-14T19:58:22Z",
    "Registrar": "Cloudflare, Inc.",
    "Registrar IANA ID": "1910",
    "Registry Registrant ID": "",
    "Registrant Name": "",
    "Registrant Organization": "",
    "Registrant Street": "",
    "Registrant City": "",
    "Registrant State/Province": "Oregon",
    "Registrant Postal Code": "",
    "Registrant Country": "US",
    "Registrant Phone": "",
    "Registrant Phone Ext": "",
    "Registrant Fax": "",
    "Registrant Fax Ext": "",
    "Registrant Email": "https://domaincontact.cloudflareregistrar.com/readthedocs.io",
    "Registry Admin ID": "",
    "Admin Name": "",
    "Admin Organization": "",
    "Admin Street": "",
    "Admin City": "",
    "Admin State/Province": "",
    "Admin Postal Code": "",
    "Admin Country": "",
    "Admin Phone": "",
    "Admin Phone Ext": "",
    "Admin Fax": "",
    "Admin Fax Ext": "",
    "Admin Email": "https://domaincontact.cloudflareregistrar.com/readthedocs.io",
    "Registry Tech ID": "",
    "Tech Name": "",
    "Tech Organization": "",
    "Tech Street": "",
    "Tech City": "",
    "Tech State/Province": "",
    "Tech Postal Code": "",
    "Tech Country": "",
    "Tech Phone": "",
    "Tech Phone Ext": "",
    "Tech Fax": "",
    "Tech Fax Ext": "",
    "Tech Email": "https://domaincontact.cloudflareregistrar.com/readthedocs.io",
    "Registry Billing ID": "",
    "Billing Name": "",
    "Billing Organization": "",
    "Billing Street": "",
    "Billing City": "",
    "Billing State/Province": "",
    "Billing Postal Code": "",
    "Billing Country": "",
    "Billing Phone": "",
    "Billing Phone Ext": "",
    "Billing Fax": "",
    "Billing Fax Ext": "",
    "Billing Email": "https://domaincontact.cloudflareregistrar.com/readthedocs.io",
    "DNSSEC": "unsigned",
    "Registrar Abuse Contact Email": "[email protected]",
    "Registrar Abuse Contact Phone": "+1.4153197517",
    "URL of the ICANN WHOIS Data Problem Reporting System": "http://wdprs.internic.net/",
    ">>> Last update of WHOIS database": "2025-06-30T21:33:51Z <<<",
    "text": [
      "For more information on Whois status codes, please visit https://icann.org/epp",
      "",
      "Cloudflare provides more than 13 million domains with the tools to give their global users a faster, more secure, and more reliable internet experience.",
      "",
      "NOTICE:",
      "",
      "Data in the Cloudflare Registrar WHOIS database is provided to you by Cloudflare",
      "under the terms and conditions at https://www.cloudflare.com/domain-registration-agreement/",
      "",
      "By submitting this query, you agree to abide by these terms.",
      "",
      "Register your domain name at https://www.cloudflare.com/registrar/"
    ]
  }
}