Status badges let you show the state of your documentation to your users. They will show if the latest build has passed, failed, or is in an unknown state. They are great for embedding in your README, or putting inside your actual doc pages.
You can see a badge in action in the Read the Docs README.
Badges have the following states which can be shown to users:
passing- the last build was successful.
failing- the last build failed.
unknown- we couldn’t figure out the status of your last build.
An example of each is shown here:
On the dashboard of a project, an example badge is displayed together with code snippets for reStructuredText, Markdown, and HTML.
Badges are generated on-demand for all Read the Docs projects, using the following URL syntax:
You can pass the
style GET argument to get custom styled badges.
This allows you to match the look and feel of your website.
By default, the
flat style is used.
flat - default
You can change the version of the documentation your badge points to.
To do this, you can pass the
version GET argument to the badge URL.
By default, it will point at the default version you have specified for your project.
The badge URL looks like this:
Badges on dashboard pages
On each project home page there is a badge that communicates the status of the default version. If you click on the badge icon, you will be given snippets for reStructuredText, Markdown, and HTML to make embedding it easier.
Badges for private projects
This feature is only available on Read the Docs for Business.
For private projects, a badge URL cannot be guessed. A token is needed to display it. Private badge URLs are displayed on a private project’s dashboard in place of public URLs.