Metadata-Version: 2.1
Name: sphinx-xournal
Version: 0.1.2
Summary: Sphinx extension to generate images from xournal files.
Keywords: sphinx,xournal,notes
Author-email: Arkadiusz Michał Ryś <Arkadiusz.Michal.Rys@gmail.com>
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Requires-Dist: sphinx>=5,<8
Requires-Dist: docutils>=0.15,<2
Requires-Dist: tox~=4.6.0 ; extra == "dev"
Requires-Dist: pip~=23.1.2 ; extra == "dev"
Requires-Dist: flit~=3.9.0 ; extra == "dev"
Requires-Dist: twine~=4.0.2 ; extra == "dev"
Requires-Dist: vermin~=1.5.1 ; extra == "dev"
Requires-Dist: invoke~=2.1.2 ; extra == "dev"
Requires-Dist: jinja2~=3.1.2 ; extra == "dev"
Requires-Dist: flake8~=6.0.0 ; extra == "dev"
Requires-Dist: coverage~=7.2.7 ; extra == "dev"
Requires-Dist: pytest~=7.3.1 ; extra == "test"
Project-URL: source, https://git.rys.one/arrys/sphinx-xournal
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: graphical
Provides-Extra: test

==============
Sphinx Xournal
==============

.. image:: https://img.shields.io/pypi/v/sphinx-xournal.svg
   :target: https://pypi.python.org/pypi/sphinx-xournal

Sphinx extension to render images of Xournal files.

Usage
-----

You will need to start by installing the extension.

.. code-block:: bash

   pip install sphinx-xournal

Your sphinx conf.py file will need a few changes.
To enable this extension it needs to be added to the extensions list.

.. code-block:: python

   extensions = [
       "sphinx_xournal",
   ]

If xournalpp is not installed in the default location you need to specify one:

.. code-block:: python

   xournal_binary_path = "/a/different/place/xournalpp"


You are now ready to include your .xopp files in your marvelous documentation.

We provide you with 3 options:

Option 1:
~~~~~~~~~

You can generate a restructured image from any Xournal files.
This block inherits all the restructured image tags, like :align:.

.. code-block:: rst

   .. xournal-image:: ./example.xopp
      :format: svg
      :align: center

      Sketch of an example.

Option 2:
~~~~~~~~~

Same applies for the figure block.

.. code-block:: rst

   .. xournal-figure:: ./example.xopp
      :format: svg
      :align: center

      Sketch of an example.

Option 3 (Experimental):
~~~~~~~~~~~~~~~~~~~~~~~~

The last option allows you to embed the raw svg.

.. code-block:: rst

   .. xournal-raw:: ./example.xopp
      :format: svg
      :align: center

      Sketch of an example.

