CINXE.COM
Blog - Read the Docs
<!DOCTYPE html> <html lang="en"> <head> <title> Blog - 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="Read the Docs" /> <meta property="twitter:title" content="Read the Docs" /> <meta name="description" content="" /> <meta property="og:description" content="" /> <meta property="twitter:description" content="" /> <meta property="og:image" content="/images/logo-opengraph.png" /> <meta property="twitter:image" content="/images/logo-opengraph.png" /> <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="/blog/" /><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> <div class="header">About</div> <a class="item" href="https://about.readthedocs.com/features/"> <i class="fad fa-arrow-progress primary icon"></i> How Read the Docs works </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"> <div class="ui wide dropdown item" data-module="dropdown" data-module-on="hover"> Product <i class="dropdown fad fa-caret-down icon"></i> <div class="menu"> <div class="header">About</div> <a class="item" href="https://about.readthedocs.com/features/"> <i class="fad fa-arrow-progress primary icon"></i> How Read the Docs works </a> <div class="header">More</div> <div class="item"> <i class="fad fa-rectangle-terminal primary icon"></i> Featured tools <i class="dropdown fad fa-caret-right icon"></i> <div class="menu"> <a class="item" href="https://about.readthedocs.com/tools/sphinx">Sphinx</a> <a class="item" href="https://about.readthedocs.com/tools/mkdocs">Mkdocs</a> <a class="item" href="https://about.readthedocs.com/tools/jupyter-book">Jupyter Book</a> <a class="item" href="https://about.readthedocs.com/tools/markdoc">Markdoc</a> <a class="item" href="https://about.readthedocs.com/tools/custom">Other tools</a> </div> </div> </div> </div> <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 very padded container"> <div class="ui breadcrumb"> <a class="section" href="/">Home</a> <div class="divider"> / </div> <div class="active section">Blog</div> </div> <div class="ui header"> Latest blog posts </div> <div class="ui info message"> <div class="header"> Welcome to our new blog </div> <div> <p> We will be adding news and updates here in the future. Make sure to subscribe if you would like to be notified of new posts. </p> <div class="ui list"> <div class="item"> <i class="fad fa-envelope icon"></i> <div class="content"> Subscribe to <a href="https://landing.mailerlite.com/webforms/landing/t0a9l4" target="_blank">our newsletter</a>. </div> </div> <div class="item"> <i class="fad fa-feed icon"></i> <div class="content"> Subscribe to <a href="/feeds/atom.xml" target="_blank">our Atom feed</a> with your favorite reader. </div> </div> <div class="item"> <i class="fad fa-clock-rotate-left icon"></i> <div class="content"> Find our past posts and updates on <a href="https://blog.readthedocs.com/archive/" target="_blank">our archived blog</a>. </div> </div> </div> </div> </div> </div> </section> <section> <div class="ui very padded container"> <div class="ui two cards stackable"> <a class="ui card" href="/blog/2025/02/newsletter-february-2025/"> <div class="image"> <img src="/images/feb-2025.jpg" alt="Photo by Banff Sunshine Village on Unsplash"> </div> <div class="content"> <div class="header">Read the Docs Newsletter - February 2025</div> <div class="meta"> <span class="date"><time datetime="2025-02-11T00:00:00-08:00">Feb 11, 2025</time></span> </div> <div class="description"> Company updates and new features from the last month, current focus, and upcoming features. </div> </div> <div class="extra content"> <div class="right floated"> Eric Holscher </div> <div class="left"> <span class="ui secondary label"> Newsletter </span> </div> </div> </a> <a class="ui card" href="/blog/2025/02/postgres-maint-feb-14/"> <div class="image"> <img src="/images/aws-rds-upgrade.png" alt="Photo by Scott Rodgerson on Unsplash"> </div> <div class="content"> <div class="header">Read the Docs Maintenance Window - February 14</div> <div class="meta"> <span class="date"><time datetime="2025-02-04T00:00:00-08:00">Feb 4, 2025</time></span> </div> <div class="description"> Upcoming upgrade for PostgreSQL to ensure minimal impact for our users. </div> </div> <div class="extra content"> <div class="right floated"> Eric Holscher </div> <div class="left"> <span class="ui secondary label"> Engineering </span> </div> </div> </a> </div> <div class="ui three cards stackable"> <a class="ui card" href="/blog/2025/01/override-build-process-with-build-jobs/"> <div class="image"> <img src="/images/override-build-steps-with-build-jobs.jpg" alt="Photo by Ryan Quintal on Unsplash"> </div> <div class="content"> <div class="header">You can now partially or completely override the build process</div> <div class="meta"> <span class="date"><time datetime="2025-01-20T00:00:00-08:00">Jan 20, 2025</time></span> </div> <div class="description"> Announcing support for partially or completely override build steps using the `build.jobs` configuration. </div> </div> <div class="extra content"> <div class="right floated"> Santos Gallegos </div> <div class="left"> <span class="ui secondary label"> Feature announcement </span> </div> </div> </a> <a class="ui card" href="/blog/2025/01/2025-vision/"> <div class="image"> <img src="/images/2025-vision.jpg" alt="Photo by Matt Noble on Unsplash"> </div> <div class="content"> <div class="header">Read the Docs 2025 Vision: great support for all documentation tools</div> <div class="meta"> <span class="date"><time datetime="2025-01-14T00:00:00-08:00">Jan 14, 2025</time></span> </div> <div class="description"> Our vision for Read the Docs in 2025, supporting all documentation tools and enhancing frontend features with Addons. </div> </div> <div class="extra content"> <div class="right floated"> Eric Holscher </div> <div class="left"> <span class="ui secondary label"> Meta </span> </div> </div> </a> <a class="ui card" href="/blog/2025/01/newsletter-january-2025/"> <div class="image"> <img src="/images/jan-2025.jpg" alt="Photo by Kelly Sikkema on Unsplash"> </div> <div class="content"> <div class="header">Read the Docs Newsletter - January 2025</div> <div class="meta"> <span class="date"><time datetime="2025-01-08T00:00:00-08:00">Jan 8, 2025</time></span> </div> <div class="description"> Company updates and new features from the last month, current focus, and upcoming features. </div> </div> <div class="extra content"> <div class="right floated"> Eric Holscher </div> <div class="left"> <span class="ui secondary label"> Newsletter </span> </div> </div> </a> <a class="ui card" href="/blog/2024/12/deprecate-config-files-without-sphinx-or-mkdocs-config/"> <div class="image"> <img src="/images/deprecated-config-file-without-sphinx-or-mkdocs-config.jpg" alt="Photo by Jernej Graj on Unsplash"> </div> <div class="content"> <div class="header">Deprecation of projects using Sphinx or MkDocs without an explicit configuration file</div> <div class="meta"> <span class="date"><time datetime="2024-12-16T00:00:00-08:00">Dec 16, 2024</time></span> </div> <div class="description"> Announcing the deprecation of projects using Sphinx or MkDocs without an explicit configuration in their configuration file. </div> </div> <div class="extra content"> <div class="right floated"> Santos Gallegos </div> <div class="left"> <span class="ui secondary label"> Changelog </span> </div> </div> </a> <a class="ui card" href="/blog/2024/12/newsletter-december-2024/"> <div class="image"> <img src="/images/december-2024.jpg" alt="Photo by Filip Bunkens on Unsplash"> </div> <div class="content"> <div class="header">Read the Docs Newsletter - December 2024</div> <div class="meta"> <span class="date"><time datetime="2024-12-11T00:00:00-08:00">Dec 11, 2024</time></span> </div> <div class="description"> Company updates and new features from the last month, current focus, and upcoming features. </div> </div> <div class="extra content"> <div class="right floated"> Eric Holscher </div> <div class="left"> <span class="ui secondary label"> Newsletter </span> </div> </div> </a> <a class="ui card" href="/blog/2024/11/embed-api-v2-deprecated/"> <div class="image"> <img src="/images/deprecated-embed-api-v2.jpg" alt="Photo by Johannes Plenio on Unsplash"> </div> <div class="content"> <div class="header">Deprecation and removal of embed API v2</div> <div class="meta"> <span class="date"><time datetime="2024-11-25T00:00:00-08:00">Nov 25, 2024</time></span> </div> <div class="description"> Announcing the deprecation and removal of embed API v2. </div> </div> <div class="extra content"> <div class="right floated"> Santos Gallegos </div> <div class="left"> <span class="ui secondary label"> Changelog </span> </div> </div> </a> </div> </div> </section> <section> <div class="ui very padded container"> <div class="ui segment basic clearing"> <a href="https://about.readthedocs.com/blog/index2.html" class="ui right labeled icon button right floated"> <i class="right arrow icon"></i> Older posts </a> </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="/comparisons/github-pages/">Comparison to GitHub Pages</a> <a class="item" href="/comparisons/gitbook/">Comparison to GitBook</a> <a class="item" href="/comparisons/cloudflare-pages/">Comparison to Cloudflare Pages</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 2022, Read the Docs, Inc & contributors </div> </div> </footer></body> </html>