| Name | sphinx-xournal JSON |
| Version |
0.1.2
JSON |
| download |
| home_page | |
| Summary | Sphinx extension to generate images from xournal files. |
| upload_time | 2023-06-11 22:02:03 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.10 |
| license | |
| keywords |
sphinx
xournal
notes
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
==============
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.
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinx-xournal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "sphinx,xournal,notes",
"author": "",
"author_email": "Arkadiusz Micha\u0142 Ry\u015b <Arkadiusz.Michal.Rys@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/9b/c9/71929bee608d734968bad47ba921e817b96b67f9b16a9d2a7b29a86a9b20/sphinx_xournal-0.1.2.tar.gz",
"platform": null,
"description": "==============\nSphinx Xournal\n==============\n\n.. image:: https://img.shields.io/pypi/v/sphinx-xournal.svg\n :target: https://pypi.python.org/pypi/sphinx-xournal\n\nSphinx extension to render images of Xournal files.\n\nUsage\n-----\n\nYou will need to start by installing the extension.\n\n.. code-block:: bash\n\n pip install sphinx-xournal\n\nYour sphinx conf.py file will need a few changes.\nTo enable this extension it needs to be added to the extensions list.\n\n.. code-block:: python\n\n extensions = [\n \"sphinx_xournal\",\n ]\n\nIf xournalpp is not installed in the default location you need to specify one:\n\n.. code-block:: python\n\n xournal_binary_path = \"/a/different/place/xournalpp\"\n\n\nYou are now ready to include your .xopp files in your marvelous documentation.\n\nWe provide you with 3 options:\n\nOption 1:\n~~~~~~~~~\n\nYou can generate a restructured image from any Xournal files.\nThis block inherits all the restructured image tags, like :align:.\n\n.. code-block:: rst\n\n .. xournal-image:: ./example.xopp\n :format: svg\n :align: center\n\n Sketch of an example.\n\nOption 2:\n~~~~~~~~~\n\nSame applies for the figure block.\n\n.. code-block:: rst\n\n .. xournal-figure:: ./example.xopp\n :format: svg\n :align: center\n\n Sketch of an example.\n\nOption 3 (Experimental):\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe last option allows you to embed the raw svg.\n\n.. code-block:: rst\n\n .. xournal-raw:: ./example.xopp\n :format: svg\n :align: center\n\n Sketch of an example.\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Sphinx extension to generate images from xournal files.",
"version": "0.1.2",
"project_urls": {
"source": "https://git.rys.one/arrys/sphinx-xournal"
},
"split_keywords": [
"sphinx",
"xournal",
"notes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dba44cf7a4b2f4404601d814b0f0db8c7ffe4f855c8238db2b6f2678fecb4f21",
"md5": "d3e86ab5b7e8233967e07c12084c3334",
"sha256": "7a36d8efdbb8a45917fc56a735fbfec02aec5930b215837532ee8a8978769d0b"
},
"downloads": -1,
"filename": "sphinx_xournal-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d3e86ab5b7e8233967e07c12084c3334",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8768,
"upload_time": "2023-06-11T22:02:01",
"upload_time_iso_8601": "2023-06-11T22:02:01.713129Z",
"url": "https://files.pythonhosted.org/packages/db/a4/4cf7a4b2f4404601d814b0f0db8c7ffe4f855c8238db2b6f2678fecb4f21/sphinx_xournal-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9bc971929bee608d734968bad47ba921e817b96b67f9b16a9d2a7b29a86a9b20",
"md5": "ba5e6b13b09ecb00c8712460a863621c",
"sha256": "0f42e38acf9cdb91c054eef5bef84d736f1268b2213378837fbe68954211c5da"
},
"downloads": -1,
"filename": "sphinx_xournal-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "ba5e6b13b09ecb00c8712460a863621c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 10485,
"upload_time": "2023-06-11T22:02:03",
"upload_time_iso_8601": "2023-06-11T22:02:03.700774Z",
"url": "https://files.pythonhosted.org/packages/9b/c9/71929bee608d734968bad47ba921e817b96b67f9b16a9d2a7b29a86a9b20/sphinx_xournal-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-11 22:02:03",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-xournal"
}
