{
    "info": {
        "author": "Johannes Schriewer",
        "author_email": "hallo@dunkelstern.de",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Console",
            "Environment :: Web Environment",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 3",
            "Topic :: Documentation",
            "Topic :: Software Development :: Documentation"
        ],
        "description": "*********************************************\nAnarchyTools Sphinx Theme and Swift Extension\n*********************************************\n\n.. contents::\n\nThis is a simplistic theme used for the AnarchyTools Swift documentation.\n\nInstallation\n============\n\nVia package\n-----------\n\nDownload the package or add it to your ``requirements.txt`` file:\n\n.. code:: bash\n\n    $ pip install anarchy-sphinx\n\nIn your ``conf.py`` file:\n\n.. code:: python\n\n    # documentation extractor and swift specific commands\n    extensions = [\"swift_domain\"]\n\n    # anarchy theme\n    import anarchy_theme\n    html_theme = \"anarchy_theme\"\n    html_theme_path = [anarchy_theme.get_html_theme_path()]\n\nVia git or download\n-------------------\n\nSymlink or subtree the ``anarchy_sphinx/anarchy_theme`` repository into your documentation at\n``docs/_themes/anarchy_theme`` and ``anarchy_sphinx/swift_domain`` to ``docs/_extensions/swift_domain``\nthen add the following two settings to your Sphinx conf.py file:\n\n.. code:: python\n\n    # documentation extractor and swift specific commands\n    import os\n    import sys\n    sys.path.insert(0, os.path.abspath('_extensions'))\n\n    extensions = [\"swift_domain\"]\n\n    # anarchy theme\n    html_theme = \"anarchy_theme\"\n    html_theme_path = [\"_themes\", ]\n\nChangelog\n=========\n\n0.3.1:\n------\n\n- Fix layout when no sidebar enabled\n- Experimental: Generate anchors like ``doc2dash`` expects them. Tell me if something breaks!\n\n0.3.0:\n------\n\n- Fix table rendering in theme\n- Make code boxes that overflow scrollable\n- Switch to bold style for active toc items\n- Bugfix: right aligned images were left aligned\n- Add bullets in front of nav items on top-bar to distinguish them\n\n0.2.0:\n------\n\n- Add ``anarchysphinx`` command line tool to bootstrap documentation\n\n\nSwift auto documentation extractor\n==================================\n\nIf you want to use the doc-string extractor for Swift you'll need to inform Sphinx about\nwhere you keep your ``*.swift`` files.\n\n.. code:: python\n\n    swift_search_path = [ \"../src\" ]\n\nIf you've set that up you can use ``.. autoswift:: <symbol>`` to let the documenter search\nfor a Swift symbol and import the documentation in place.\n\nYou may set some flags to configure documentation behaviour:\n\n- ``:noindex:`` do not add to index\n- ``:noindex-members:`` do not index members\n- ``:members:`` document members, optional: list of members to include\n- ``:recursive-members:`` recursively document members (enums nested in classes, etc.)\n- ``:undoc-members:`` include members without docstring\n- ``:nodocstring:`` do not show the docstring\n- ``:file-location:`` add a paragraph with the file location\n- ``:exclude-members:`` exclude these members\n- ``:private-members:`` show private members\n\n\nManual documentation for Swift types\n====================================\n\nThe Swift Domain contains the following directives, if the directive declares what you\ndocument you can skip the corresponding Swift keyword (Example: ``.. swift:class:: Classname``)\n\n- ``.. swift:function::`` toplevel functions\n- ``.. swift:class::`` class definitions\n- ``.. swift:struct::`` struct definitions\n- ``.. swift:enum::`` enum definitions\n- ``.. swift:protocol::`` protocol definitions\n- ``.. swift:extension::`` extensions and default implementations for protocols\n- ``.. swift:method::`` func signatures\n- ``.. swift:class_method::`` class functions\n- ``.. swift:static_method::`` static methods in structs or protocols\n- ``.. swift:init::`` initializers\n- ``.. swift:enum_case::`` enum cases\n- ``.. swift:let::`` let constants\n- ``.. swift:var::`` variables\n- ``.. swift:static_let::`` static let constants\n- ``.. swift:static_var::`` static variables\n\nall of those have a ``:noindex:`` parameter to keep it out of the index.\n\n\n``anarchysphinx`` command line tool\n===================================\n\n.. code::\n\n    usage: anarchysphinx [-h] [--private] [--overwrite] [--undoc-members]\n                         [--no-members] [--file-location] [--no-index]\n                         [--no-index-members] [--exclude-list file]\n                         [--use-autodocumenter]\n                         source_path documentation_path\n\n    Bootstrap ReStructured Text documentation for Swift code.\n\n    positional arguments:\n      source_path           Path to Swift files\n      documentation_path    Path to generate the documentation in\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      --private             Include private and internal members\n      --overwrite           Overwrite existing documentation\n      --undoc-members       Include members without documentation block\n      --no-members          Do not include member documentation\n      --file-location       Add a paragraph with file location where the member\n                            was defined\n      --no-index            Do not add anything to the index\n      --no-index-members    Do not add members to the index, just the toplevel\n                            items\n      --exclude-list file   File with exclusion list for members\n      --use-autodocumenter  Do not dump actual documentation but rely on the auto\n                            documenter, may duplicate documentation in case you\n                            have defined extensions in multiple files\n\nGenerate Dash docsets with sphinx\n=================================\n\nAdd the following to your sphinx ``Makefile``. You will need the pip package\n``doc2dash`` installed for this to work.\n\nOn top in the variable declaration section::\n\n    PROJECT_NAME=myproject\n\nIn the helptext section::\n\n    @echo \"  dashdoc    to make Dash docset\"\n\nBelow the ``html`` target::\n\n    .PHONY: dashdoc\n    dashdoc:\n        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) -D 'html_sidebars.**=\"\"' $(BUILDDIR)/dashdoc\n        doc2dash -v -n $(PROJECT_NAME) -d $(BUILDDIR)/ -f -I index.html -j $(BUILDDIR)/dashdoc\n        @echo\n        @echo \"Build finished. The Docset is in $(BUILDDIR)/$(PROJECT_NAME).docset.\"\n\nand run the build with ``make dashdoc``",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/AnarchyTools/anarchySphinx",
        "keywords": "",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "anarchy-sphinx",
        "package_url": "https://pypi.org/project/anarchy-sphinx/",
        "platform": "",
        "project_url": "https://pypi.org/project/anarchy-sphinx/",
        "project_urls": {
            "Homepage": "https://github.com/AnarchyTools/anarchySphinx"
        },
        "release_url": "https://pypi.org/project/anarchy-sphinx/0.3.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "AnarchyTools Theme and Swift support for Sphinx.",
        "version": "0.3.1"
    },
    "last_serial": 2199866,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ad4f23778dfbc5e4c6699f29afdc141e",
                    "sha256": "9da63aecab13a3bb56f85330362d59dfac2f6bf585bc309bbe7346cb599d3210"
                },
                "downloads": -1,
                "filename": "anarchy_sphinx-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "ad4f23778dfbc5e4c6699f29afdc141e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 15519,
                "upload_time": "2016-06-08T00:43:30",
                "url": "https://files.pythonhosted.org/packages/24/30/09195111013a067fc81e83ec28be0da75c567970c87696c7161252b9969a/anarchy_sphinx-0.1.0.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6071dc4d7cf22574632d00f746e98f64",
                    "sha256": "cfcf8a013e2afcb361643d06646b270d2897d13498b2a578e40d8db00933fd4b"
                },
                "downloads": -1,
                "filename": "anarchy_sphinx-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "6071dc4d7cf22574632d00f746e98f64",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 18965,
                "upload_time": "2016-06-09T00:16:43",
                "url": "https://files.pythonhosted.org/packages/92/d7/c86bc1a8b448bc14cb3643d5266fe7d450aff0e25d651d70de97bc07f4c9/anarchy_sphinx-0.2.0.tar.gz"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c76816d871995c9bfd7e49f1cf2153c2",
                    "sha256": "701e8384ffc87d9a9ce7464cdc3f45c2dddb5d5f7d3df8f35fac4ed62dbb82cc"
                },
                "downloads": -1,
                "filename": "anarchy_sphinx-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "c76816d871995c9bfd7e49f1cf2153c2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 18977,
                "upload_time": "2016-06-09T01:27:59",
                "url": "https://files.pythonhosted.org/packages/03/37/0a541939ab249ea071acb9aca2272f5de0ed844ab66a56efcd601809f994/anarchy_sphinx-0.2.1.tar.gz"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "cf983c543239599d5cbb588006a50f73",
                    "sha256": "daaf85dcd1fc991693d139a8a7add87ac7907ff823beca6b42b04f509e3638de"
                },
                "downloads": -1,
                "filename": "anarchy_sphinx-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "cf983c543239599d5cbb588006a50f73",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 19629,
                "upload_time": "2016-06-14T14:12:48",
                "url": "https://files.pythonhosted.org/packages/2b/69/7e9798ea462a55d305a7bad52e9b7b3e71cd88bbaa9e4b8ce9fc7bcaf97f/anarchy_sphinx-0.3.0.tar.gz"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "47c5e2c8b2a4c99b09783863135004f2",
                    "sha256": "21bd88251305f205bfb93da32464cf8e7d9ab2c672c214ea6b1dd3d61bb12ed5"
                },
                "downloads": -1,
                "filename": "anarchy_sphinx-0.3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "47c5e2c8b2a4c99b09783863135004f2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 20602,
                "upload_time": "2016-06-19T00:28:09",
                "url": "https://files.pythonhosted.org/packages/53/39/6976ce9ba58e92cf059af98f47d6ea5d63c0f99a30f81a242b3e44b9966c/anarchy_sphinx-0.3.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "47c5e2c8b2a4c99b09783863135004f2",
                "sha256": "21bd88251305f205bfb93da32464cf8e7d9ab2c672c214ea6b1dd3d61bb12ed5"
            },
            "downloads": -1,
            "filename": "anarchy_sphinx-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "47c5e2c8b2a4c99b09783863135004f2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20602,
            "upload_time": "2016-06-19T00:28:09",
            "url": "https://files.pythonhosted.org/packages/53/39/6976ce9ba58e92cf059af98f47d6ea5d63c0f99a30f81a242b3e44b9966c/anarchy_sphinx-0.3.1.tar.gz"
        }
    ]
}