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

.. automodule:: origen.web.shorthand.shorthand

   .. contents::
      :local:

.. currentmodule:: origen.web.shorthand.shorthand


Functions
=========

- :py:func:`all_from_category`:
  Undocumented.

- :py:func:`all_include_rsts`:
  Returns the output files for all RSTs, from all namespaces 

- :py:func:`generate`:
  Updates the ``shorthand_defs`` with definitions from the user's config and

- :py:func:`get`:
  Retrieves a target 

- :py:func:`split_namespace`:
  Splits a namespaced target into its namespace and target components 


.. autofunction:: all_from_category

.. autofunction:: all_include_rsts

.. autofunction:: generate

.. autofunction:: get

.. autofunction:: split_namespace


Classes
=======

- :py:class:`ShorthandDefs`:
  Undocumented.

- :py:class:`Target`:
  Represents a single, unresolved target, in any namespace 


.. autoclass:: ShorthandDefs
   :members:
   :undoc-members:
   :inherited-members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ShorthandDefs
      :parts: 1
.. autoclass:: Target
   :members:
   :undoc-members:
   :inherited-members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: Target
      :parts: 1