Metadata-Version: 2.0
Name: sphinxcontrib-tryton
Version: 0.1.0
Summary: A Sphinx extension that enables better documentation of Tryton.
Home-page: https://bitbucket.org/libateq/sphinxcontrib-tryton
Author: David Harper
Author-email: python-packages@libateq.org
License: GPL-3
Project-URL: Bug Tracker, https://bitbucket.org/libateq/sphinxcontrib-tryton/issues
Project-URL: Documentation, https://sphinxcontrib-tryton.readthedocs.org/
Project-URL: Source Code, https://bitbucket.org/libateq/sphinxcontrib-tryton
Keywords: sphinx tryton documentation
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Requires-Python: >=3.5
Requires-Dist: Sphinx (>=2.0.0)
Requires-Dist: proteus (>=5.0.0)

Tryton Markup for Sphinx
########################

The *sphinxcontrib-tryton* package is an extension to Sphinx_.  It aims to
allow better documentation for Tryton_ by providing a ``tryton`` domain and
other features which are then used to query a ``trytond`` server and get
information and screenshots from a Tryton installation.

This extension was inspired by the trydoc_ extension.

.. _Sphinx: http://www.sphinx-doc.org/
.. _Tryton: http://www.tryton.org/
.. _trydoc: https://bitbucket.org/nantic/trydoc

.. start-of-readme-only-text


Installation
============

.. code:: bash

    pip3 install sphinxcontrib-tryton


Usage
=====

Please refer to the documentation_ for further information.

.. _documentation: https://sphinxcontrib-tryton.readthedocs.org/


