Status Badges

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.

Display states

Badges have the following states which can be shown to users:

  • Green: passing - the last build was successful.

  • Red: failing - the last build failed.

  • Yellow: unknown - we couldn’t figure out the status of your last build.

An example of each is shown here:

green red yellow

Style

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.

Style

Badge

flat - default

Flat Badge

flat-square

Flat-Square Badge

for-the-badge

Badge

plastic

Plastic Badge

social

Social Badge

Version-specific badges

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:

https://readthedocs.org/projects/docs/badge/?version=latest

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.