Skip to content

Commit

Permalink
Read The Docs (RTD) badge.
Browse files Browse the repository at this point in the history
This commit adds a badge (i.e., shield, status icon) to our front-facing
documentation signifying the success of the most recent attempt to build
and host our Sphinx-based documentation at Read The Docs (RTD).
Relatedly, this commit also resolves a trivial reST error with respect
to the index of that documentation. (*Ignominious gnomes of a cognoscenti's cognomen!*)
  • Loading branch information
leycec committed Jan 22, 2021
1 parent 80cbba5 commit 384d36c
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
|beartype-banner|
=================

|ci-badge|
|ci-badge| |rtd-badge|

.. parsed-literal::
Expand Down Expand Up @@ -2471,11 +2471,14 @@ application stack at tool rather than Python runtime) include:

.. # ------------------( IMAGES )------------------
.. |beartype-banner| image:: https://raw.githubusercontent.com/beartype/beartype-assets/main/banner/logo-small.png
:target: https://beartype.rtfd.org
:target: https://beartype.rtfd.io
:alt: beartype —[ the bare-metal type checker ]—
.. |ci-badge| image:: https://github.com/beartype/beartype/workflows/tests/badge.svg
:target: https://github.com/beartype/beartype/actions?workflow=tests
:alt: beartype continuous integration (CI) status
.. |rtd-badge| image:: https://readthedocs.org/projects/beartype/badge/?version=latest
:target: https://beartype.readthedocs.io/en/latest/?badge=latest
:alt: beartype Read The Docs (RTD) status

.. # ------------------( LINKS ~ beartype : local )------------------
.. _beartype license:
Expand Down
6 changes: 3 additions & 3 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,10 @@
tutorial

.. # ------------------( IMAGES )------------------
.. |beartype-logo| image:: https://raw.githubusercontent.com/beartype/beartype-assets/main/banner/logo.png
:width: 510 px
:target: https://beartype.rtfd.org
.. |beartype-banner| image:: https://raw.githubusercontent.com/beartype/beartype-assets/main/banner/logo.png
:target: https://github.com/beartype/beartype
:alt: beartype —[ the bare-metal type checker ]—
:width: 510 px

.. # ------------------( LINKS ~ kipling )------------------
.. _The Jungle Book:
Expand Down

0 comments on commit 384d36c

Please sign in to comment.