{
    "info": {
        "author": "Arello Mobile",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5"
        ],
        "description": "Sphinx Confluence Plugin\n========================\n\n|Build Status|\n\nSphinx extension for making the documentation compatible with the\n`Confluence Storage\nFormat <https://confluence.atlassian.com/display/DOC/Confluence+Storage+Format>`__.\n\nFeatures:\n\n-  base HTML elements\n-  images (image, figure)\n-  code blocks (::) and includes (literalinclude)\n-  referencing downloadable files (:download:)\n-  the TOC tree (.. toctree::)\n-  internal links (:ref: ``<label>``; .. \\_)\n-  Inline and table Jira Issues\n-  Reference for Confluence User\n-  Info, Tip, Note, and Warning Macros\n\nWhy?\n----\n\nThis extension is written as part of our Documentation Toolkit which we\nuse in our job daily. The main idea of toolkit is to make a process of\ncreating and updating documentation able to be automated\n\nOther parts of our toolkit is:\n\n-  `py2swagger <https://github.com/Arello-Mobile/py2swagger>`__\n-  `swagger2rst <https://github.com/Arello-Mobile/swagger2rst>`__\n-  `sphinx-confluence <https://github.com/Arello-Mobile/sphinx-confluence>`__\n-  `confluence-publisher <https://github.com/Arello-Mobile/confluence-publisher>`__\n\nInstall\n=======\n\nInstall Sphinx Confluence Plugin from\n`PyPI <https://pypi.python.org/pypi/sphinx-confluence>`__ with\n\n::\n\n    $ pip install sphinx-confluence\n\nHow use it\n----------\n\nFirst of all, after installation, you must enable this plugin in your\n`build configuration\nfile <http://www.sphinx-doc.org/en/stable/config.html#confval-extensions>`__\n``conf.py`` by adding ``sphinx_confluence`` into ``extensions`` list.\nThis should looks like a:\n\n::\n\n    ...\n    extensions = ['sphinx_confluence']\n    ...\n\nThen you can build you documentation into ``html`` or ``json`` formats,\neither by using `sphinx build\ncommand <http://www.sphinx-doc.org/en/stable/tutorial.html#running-the-build>`__\nor if you uses ``sphinx-quickstart`` script by following commands: -\n``make html`` - ``make singlehtml`` - ``make json``\n\nAfter that, the results must be in Confluence Storage Format. You can\nuse\n`confluence-publisher <https://github.com/Arello-Mobile/confluence-publisher>`__\nfor publish them to your Confluence.\n\nAdditional Markup Constructs\n----------------------------\n\nSphinx Confluence Plugin adds few new directives to standard reST\nmarkup.\n\nJira Issues\n~~~~~~~~~~~\n\n**Inline**\n\n.. code:: rst\n\n    Lorem ipsum dolor sit amet, :jira_issue:`PROJECT-123` consectetur adipiscing elit\n\n**Table View**\n\n*Markup:*\n\n.. code:: rst\n\n    .. jira_issues:: <JQL query>\n       :anonymous: 'true'|'false' (default: 'false')\n       :server_id: 'string' (default: '')\n       :baseurl: 'string' (default: '')\n       :columns: A list of JIRA column names, separated by semi-colons (;)\n       :count: 'true'|'false' (default: 'false')\n       :height: int (default: 480)\n       :title: 'string' (default: '')\n       :render_mode: 'static'|'dynamic' (default: 'static')\n       :url: 'string' (default: '')\n       :width: '{x}px' | '{x}%' (default: '100%')\n       :maximum_issues: int (default: 20)\n\n*Example:*\n\n.. code:: rst\n\n    .. jira_issues:: project = PROJ AND issuetype = Epic AND resolution = Unresolved\n       :title: Unresolved project epics\n       :columns: type;key;summary;status;created;\n       :width: 80%\n\nJira Users\n~~~~~~~~~~\n\n.. code:: rst\n\n    Lorem ipsum dolor sit amet, :jira_user:`username` consectetur adipiscing elit\n\n.. |Build Status| image:: https://travis-ci.org/Arello-Mobile/sphinx-confluence.svg?branch=master\n   :target: https://travis-ci.org/Arello-Mobile/sphinx-confluence",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/Arello-Mobile/sphinx-confluence",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sphinx-confluence",
        "package_url": "https://pypi.org/project/sphinx-confluence/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/sphinx-confluence/",
        "project_urls": {
            "Homepage": "https://github.com/Arello-Mobile/sphinx-confluence"
        },
        "release_url": "https://pypi.org/project/sphinx-confluence/0.0.3/",
        "requires_dist": [
            "Sphinx (>=1.3.5)"
        ],
        "requires_python": "",
        "summary": "Atlassian Confluence extension for sphinx",
        "version": "0.0.3"
    },
    "last_serial": 2343968,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c5e55aacb4386ac7a1635cb61f399048",
                    "sha256": "5ac63eb734d34f9e24c60aa9f1b532a1f518890883f72c09ad6585b9da4333f1"
                },
                "downloads": -1,
                "filename": "sphinx-confluence-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "c5e55aacb4386ac7a1635cb61f399048",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5110,
                "upload_time": "2015-11-12T08:43:48",
                "url": "https://files.pythonhosted.org/packages/8d/92/3c0956efb6c7f2d3424dfb82d96d23ddc00f5777723c7546d9f8d252f509/sphinx-confluence-0.0.1.tar.gz"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "779e1be54a58ea64189b924060cdb5fb",
                    "sha256": "4db0fc1107f7952615bf88889dc75da609fc3919599f4093eeda9bcf74662d54"
                },
                "downloads": -1,
                "filename": "sphinx-confluence-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "779e1be54a58ea64189b924060cdb5fb",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5387,
                "upload_time": "2015-11-23T05:45:48",
                "url": "https://files.pythonhosted.org/packages/24/17/4849f3e1c0201bb2b4c64ea1d3d687162303a600e88f08fd103ce4a92bdb/sphinx-confluence-0.0.2.tar.gz"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "da044ff23367e615c12ff30d4d849f9c",
                    "sha256": "8f53042f9c8f91760f668e24e6b924784b64c3e5f021ff060a5d1b1fa88f0478"
                },
                "downloads": -1,
                "filename": "sphinx_confluence-0.0.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "da044ff23367e615c12ff30d4d849f9c",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 10952,
                "upload_time": "2016-09-15T10:41:24",
                "url": "https://files.pythonhosted.org/packages/62/92/9bcae1265a417b09910db060b43a41daec8fddb84bd36369667cae687ef7/sphinx_confluence-0.0.3-py2.py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "da044ff23367e615c12ff30d4d849f9c",
                "sha256": "8f53042f9c8f91760f668e24e6b924784b64c3e5f021ff060a5d1b1fa88f0478"
            },
            "downloads": -1,
            "filename": "sphinx_confluence-0.0.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "da044ff23367e615c12ff30d4d849f9c",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 10952,
            "upload_time": "2016-09-15T10:41:24",
            "url": "https://files.pythonhosted.org/packages/62/92/9bcae1265a417b09910db060b43a41daec8fddb84bd36369667cae687ef7/sphinx_confluence-0.0.3-py2.py3-none-any.whl"
        }
    ]
}