========================
``origen.web.shorthand``
========================

.. automodule:: origen.web.shorthand

   .. contents::
      :local:


Submodules
==========

.. toctree::

   origen.web.shorthand.dev
   origen.web.shorthand.shorthand

.. currentmodule:: origen.web.shorthand


Functions
=========

- :py:func:`add_defs`:
  Dynamically adds **namespaced** definitions and generates the appropriate output files.

- :py:func:`anchor_to`:
  Although in this phase we *could* generate RST, we don't actually know the context

- :py:func:`check_consistency`:
  Targets here bypass Sphinx's ref/doc/whatever checkers and could potentially allow

- :py:func:`check_link`:
  Checks if the given link points to *somewhere* 

- :py:func:`href_to`:
  Generates an href for the target. The exact nature is determined by the HREF type.

- :py:func:`link_to`:
  Inserts a ``shorthand-link-to`` role with the given target and txt 

- :py:func:`set_default_output_dir`:
  Undocumented.

- :py:func:`setup`:
  Callback for Sphinx to setup the extension.

- :py:func:`templating_context`:
  Undocumented.

- :py:func:`update_unchecked_targets`:
  Undocumented.


.. autofunction:: add_defs

.. autofunction:: anchor_to

.. autofunction:: check_consistency

.. autofunction:: check_link

.. autofunction:: href_to

.. autofunction:: link_to

.. autofunction:: set_default_output_dir

.. autofunction:: setup

.. autofunction:: templating_context

.. autofunction:: update_unchecked_targets