**********
Build Docs
**********

.. mdinclude:: ../../reusable-actions/build-docs/README.md

Templates
=========

PR Template
-----------

Run the documentation but don't publish it.  This is good to check that the documents build without errors

.. literalinclude:: ../../reusable-actions/build-docs/pr-template.yml
   :language: yaml

Push Template
-------------

Run the documentation and publish it.  This is good after the PR has been merged so that the published documents are always up-to-date.

.. literalinclude:: ../../reusable-actions/build-docs/push-template.yml
   :language: yaml