https://blog.readthedocs.comRead the Docs Blog - Posts tagged badges2023-07-08T10:50:30.051239+00:00ABloghttps://blog.readthedocs.com/badge-support/Badge Support2014-08-14T00:00:00+00:00Eric Holscher<section id="badge-support">
<p>Documentation is an often overlooked part of a software project.
Today we are releasing badges for your docs,
so that people can easily see that your docs are up-to-date.</p>
<section id="status-badges">
<h2>Status Badges</h2>
<p>The main use of badges is to show the status of your project’s build.
They will display in green for passing,
red for failing,
and yellow for unknown states.</p>
<p>Here are a few examples:</p>
<p><img alt="green" src="http://img.shields.io/badge/Docs-latest-green.svg" /> <img alt="red" src="http://img.shields.io/badge/Docs-release--1.6-red.svg" /> <img alt="yellow" src="http://img.shields.io/badge/Docs-No%20Builds-yellow.svg" /></p>
<p>You can see it in action in the <a class="reference external" href="https://github.com/rtfd/readthedocs.org/blob/master/README.rst">Read the Docs README</a>.
They will link back to your project’s documentation page on Read the Docs.</p>
</section>
<section id="project-pages">
<h2>Project Pages</h2>
<p>You will now see badges embedded in your <a class="reference external" href="https://readthedocs.org/projects/pip/">project page</a>.
The default badge will be pointed at the <em>default version</em> you have specified for your project.
The badge URLs look like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>https://readthedocs.org/projects/pip/badge/?version=latest
</pre></div>
</div>
<p>You can replace the version argument with any version that you want to show a badge for.
If you click on the badge icon,
you will be given snippets for RST, Markdown, and HTML;
to make embedding it easier.</p>
<p>If you leave the version argument off,
it will default to your latest version.
This is probably best to include in your README,
since it will stay up to date with your Read the Docs project.</p>
</section>
<section id="design">
<h2>Design</h2>
<p>We have often wondered what we might make our badges look like.
Luckily,
there is a developing standard and service to support badges.
<a class="reference external" href="http://shields.io">http://shields.io</a> is what we’ll be using to generate our badges,
and they look beautiful.</p>
</section>
<section id="feature-requests">
<h2>Feature Requests</h2>
<p>This is an initial attempt at adding badges to Read the Docs,
it’s a feature we’ve wanted to add for some time.
We have some plans to improve badges further,
but be sure to get in touch with us if you have any feedback on how you would like to see badges used.</p>
<p>Feel free to <a class="reference external" href="https://github.com/rtfd/readthedocs.org/issues">file an issue</a>,
or you can always reach us at <a class="reference external" href="mailto:readthedocs%40gmail.com">readthedocs<span>@</span>gmail<span>.</span>com</a>.</p>
</section>
</section>
Documentation is an often overlooked part of a software project.
Today we are releasing badges for your docs,
so that people can easily see that your docs are up-to-date.The main use of badges is to show the status of your project’s build.
They will display in green for passing,
red for failing,
and yellow for unknown states.2014-08-14T00:00:00+00:00