{
    "info": {
        "author": "Ved Vyas",
        "author_email": "ved@vyas.io",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Topic :: Software Development :: Documentation"
        ],
        "description": "doxytag2zealdb\n==============\n\ndoxytag2zealdb creates a SQLite3 database from a Doxygen tag file to enable\nsearchable Doxygen docsets with categorized entries in tools like\n[helm-dash][1], [Zeal][2], and [Dash][3].\n\n## Introduction ##\n\n[Doxygen's `GENERATE_DOCSET`][4] configuration option does most of the work to\nget a usable docset for use with helm-dash and friends. However, one still has\nto write a SQLite3 database to facilitate searching and browsing by entry type.\n\ndoxytag2zealdb uses [Beautiful Soup][5] to traverse Doxygen tag files, then\nextracts and prepares entries to write to the DB as suggested in the\n[Dash guide on generating docsets][6]. By default, it also updates\n`Info.plist`, which is expected to be one directory-level up from the output\nDB, to indicate that a Dash-style docset index is used (for Dash users). This\ncan be disabled by specifying `--dont-update-info-plist`.\n\ndoxytag2zealdb has been developed against the Doxygen tag file output for a few\nC++ codebases. At present:\n\n- Several Doxygen tag file entry types are mapped to their corresponding docset\n  entry types. There may be more mapping opportunities to the [entry types][7]\n  in the docset generation guide.\n\n- There are command-line options to include function arguments and return types\n  in entry names (e.g., `some_func(int &output, const double input) -> bool` by\n  specifying `--include-function-signatures`) and include the parent scope in\n  entry names for class/struct/namespace members (e.g., `SomeClass::Method` by\n  specifying `--include-parent-scopes`). These options can be combined.\n\n## Requirements ##\n\nPython 2.7 or Python 3 with `beautifulsoup4` (4.4.1), `lxml` (3.6.0), and\n`docopt` (0.6.2)\n\n## Installation ##\n\nThe `doxytag2zealdb` module can be executed directly from a repository\nclone or extracted source tarball, provided that the requirements are\ninstalled, using `python -m doxytag2zealdb`.\n\nAlternatively, one may may run `setup.py` (`python setup.py install`) or\ninstall from PyPI (`pip install [--user] [--upgrade] doxytag2zealdb`). Note\nthat the entrypoint is simply `doxytag2zealdb` when installing via these\nmethods.\n\n## Typical Usage ##\n\n1. Suppose you have a project named `foo` with Doxygen configuration in\n   `foo.dox`. As suggested in the\n   [Doxygen section of the Dash docset guide][8], at least make sure\n   `GENERATE_DOCSET = yes` in `foo.dox`. Ensure HTML output is enabled and\n   also specify tag file generation with\n   `GENERATE_TAGFILE = /path/to/desired/foo.tag`. You may wish to further\n   customize `DOCSET_BUNDLE_ID` (which controls the name of the docset\n   subdirectory), other `DOCSET_*` options, and the other options mentioned in\n   the guide.\n\n2. If the top-level Doxygen output directory is `output`, go to `output/html/`\n   and run `make`. An error about missing `docsetutil` is fine (and expected\n   when not using macOS and an old-enough Xcode install). Also,\n   `output/html/$(DOCSET_BUNDLE_ID).docset/Contents/Info.plist` [should have\n   the `isDashDocset` key set to `true`][9]. doxytag2zealdb will do this\n   automatically; additionally pass `--dont-update-info-plist` in the next step\n   if this is not desired.\n\n3. The SQLite DB is expected to be named `docSet.dsidx` and placed in the\n   directory `output/html/$(DOCSET_BUNDLE_ID).docset/Contents/Resources/`,\n   where `$(DOCSET_BUNDLE_ID)` may be something like `org.doxygen.Project` if\n   left uncustomized in `foo.dox`. This is where doxytag2zealdb comes in:\n\n        [python -m] doxytag2zealdb --tag /path/to/desired/foo.tag \\\n          --db /path/to/output/html/$(DOCSET_BUNDLE_ID).docset/Contents/Resources/docSet.dsidx \\\n          --include-parent-scopes --include-function-signatures\n\n4. After adding an icon and whatever else,\n   `output/html/$(DOCSET_BUNDLE_ID).docset` should be ready to use with the\n   tool of your choice.\n\n## Extending It ##\n\nThere are multiple ways to extend doxytag2zealdb's behavior:\n\n- Options can be added to existing `TagProcessor`s. See `TagProcessor` and\n  `functionTagProcessor` for examples of this. Also see how keyword arguments\n  get passed around from `doxytag2zealdb.py` to `TagfileProcessor` to\n  `TagProcessor`s and their superclasses.\n\n- One can subclass `TagProcessor` (or one of its existing child classes) to\n  handle a new tag case. Then add it to the registrations in\n  `TagfileProcessor.init_tag_processors()` or separately register it at\n  runtime, if you like.\n\n- Command-line options are easily added using [docopt][10]. See the module\n  docstring and code in `doxytag2zealdb.py`.\n\n- ...\n\n## Contributing ##\n\nPlease file issues and submit pull (merge) requests upstream at\n<https://gitlab.com/vedvyas/doxytag2zealdb>.\n\n## License ##\n\ndoxytag2zealdb is distributed under the terms of the GNU General Public License\nversion 3 or (at your option) any later version. Please see COPYING.\n\n[1]: https://github.com/areina/helm-dash\n[2]: https://github.com/zealdocs/zeal\n[3]: https://kapeli.com/dash\n[4]: http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_generate_docset\n[5]: https://www.crummy.com/software/BeautifulSoup\n[6]: https://kapeli.com/docsets#createsqlite\n[7]: https://kapeli.com/docsets#supportedentrytypes\n[8]: https://kapeli.com/docsets#doxygen\n[9]: https://kapeli.com/resources/Info.plist\n[10]: http://docopt.org\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "https://gitlab.com/vedvyas/doxytag2zealdb/repository/archive.tar.bz2?ref=v0.3.1",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://gitlab.com/vedvyas/doxytag2zealdb",
        "keywords": "Zeal Dash Doxygen SQLite3",
        "license": "GPLv3+",
        "maintainer": "",
        "maintainer_email": "",
        "name": "doxytag2zealdb",
        "package_url": "https://pypi.org/project/doxytag2zealdb/",
        "platform": "",
        "project_url": "https://pypi.org/project/doxytag2zealdb/",
        "project_urls": {
            "Download": "https://gitlab.com/vedvyas/doxytag2zealdb/repository/archive.tar.bz2?ref=v0.3.1",
            "Homepage": "https://gitlab.com/vedvyas/doxytag2zealdb"
        },
        "release_url": "https://pypi.org/project/doxytag2zealdb/0.3.1/",
        "requires_dist": [
            "docopt (>=0.6.2)",
            "lxml (>=3.6.0)",
            "beautifulsoup4 (>=4.4.1)",
            "future"
        ],
        "requires_python": "",
        "summary": "doxytag2zealdb creates a SQLite3 database from a Doxygen tag file to enable searchable Doxygen docsets with categorized entries in tools like helm-dash, Zeal, and Dash.",
        "version": "0.3.1"
    },
    "last_serial": 5711948,
    "releases": {
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "fc34e4457b819d17ed6cc830bc2ec1b9",
                    "sha256": "60b3d60a0ea20d5354a1a7814491fafcca2fcc9baf5e223308b672e3edbe74bf"
                },
                "downloads": -1,
                "filename": "doxytag2zealdb-0.1.2-py2-none-any.whl",
                "has_sig": true,
                "md5_digest": "fc34e4457b819d17ed6cc830bc2ec1b9",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 30250,
                "upload_time": "2016-07-09T21:28:53",
                "url": "https://files.pythonhosted.org/packages/fd/93/5ec295ef5d38fbec4a14af9d09bda5115313362a88a008c6fbbbecd48670/doxytag2zealdb-0.1.2-py2-none-any.whl"
            }
        ],
        "0.2.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8b03c338f0595806f36ea54d1574339c",
                    "sha256": "b9eedd304b2a2bbf9cb5c1cce827b7402ada61aee2e878de681920ac4642fedc"
                },
                "downloads": -1,
                "filename": "doxytag2zealdb-0.2.6-py2-none-any.whl",
                "has_sig": true,
                "md5_digest": "8b03c338f0595806f36ea54d1574339c",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 32368,
                "upload_time": "2017-05-22T05:54:09",
                "url": "https://files.pythonhosted.org/packages/0d/64/1d67cbdfbe2173260bf33a659ec4cec5c8ad2593360288dd1eca93d0530c/doxytag2zealdb-0.2.6-py2-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b118ef88efe08e4af052415cbb762670",
                    "sha256": "b0d791b5c0f92f3834efd84bfebc159c8b2299031cdc1b547e84158d2c0eaf53"
                },
                "downloads": -1,
                "filename": "doxytag2zealdb-0.2.6-py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "b118ef88efe08e4af052415cbb762670",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 32369,
                "upload_time": "2017-05-22T05:54:50",
                "url": "https://files.pythonhosted.org/packages/c6/0b/d9056c7cdcf3ca31b3ef8d5bb8380d9c8a61b41a9605c27a29b6a990ae4a/doxytag2zealdb-0.2.6-py3-none-any.whl"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "af1bba90413065e15dd7aeea7c346824",
                    "sha256": "8a6d96c8e1fb8e26042ebcb5bd5284fdead1aebc3642e805e11ca9dac946e0cf"
                },
                "downloads": -1,
                "filename": "doxytag2zealdb-0.3.0-py2-none-any.whl",
                "has_sig": true,
                "md5_digest": "af1bba90413065e15dd7aeea7c346824",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 44169,
                "upload_time": "2019-03-14T00:07:54",
                "url": "https://files.pythonhosted.org/packages/10/42/c48067c7ac3f3eab882bc32244736896163f082cc4fe7243870b86481572/doxytag2zealdb-0.3.0-py2-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "11aca7cfb63c0b28355d3cc0afd14f56",
                    "sha256": "60bc00d692313a94c5a818452c7e689aa92791cb1479f0c3c223da7458b8ac82"
                },
                "downloads": -1,
                "filename": "doxytag2zealdb-0.3.0-py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "11aca7cfb63c0b28355d3cc0afd14f56",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 44169,
                "upload_time": "2019-03-14T00:07:56",
                "url": "https://files.pythonhosted.org/packages/0c/1d/12bb58d9c232e1ca223b241d0d78175b1ef6f51d2f76cf5c90214c115991/doxytag2zealdb-0.3.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f771fd51ee9230bad4035b82757b62a",
                    "sha256": "f3d7fba615bba9687aae4a331d2de95c4aaf1c709f77569a5f1420f8abce895a"
                },
                "downloads": -1,
                "filename": "doxytag2zealdb-0.3.0.tar.gz",
                "has_sig": true,
                "md5_digest": "8f771fd51ee9230bad4035b82757b62a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 26498,
                "upload_time": "2019-03-14T00:07:57",
                "url": "https://files.pythonhosted.org/packages/a9/bf/3d6b56c01c630942575c2ecd5d8b00e31e04b369933f2286684b0406657e/doxytag2zealdb-0.3.0.tar.gz"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "714160c53c6e3ca6b262f3cf5e0ce5be",
                    "sha256": "a6a637219840580d5110c4d5491f522d676e62ebbe05a7eb86ce6e89f45b4529"
                },
                "downloads": -1,
                "filename": "doxytag2zealdb-0.3.1-py2-none-any.whl",
                "has_sig": true,
                "md5_digest": "714160c53c6e3ca6b262f3cf5e0ce5be",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 44433,
                "upload_time": "2019-08-21T21:53:56",
                "url": "https://files.pythonhosted.org/packages/f4/ad/bdafe421a11de83490c2609d6cb919f2851b17f958d35061a4cef6be05b2/doxytag2zealdb-0.3.1-py2-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d9455ee052c8d98c2253c6759ad7c247",
                    "sha256": "fd731ee85e8087ef119900a8997afc988ccd66aebe175528cf6f01aa6663c955"
                },
                "downloads": -1,
                "filename": "doxytag2zealdb-0.3.1-py3-none-any.whl",
                "has_sig": true,
                "md5_digest": "d9455ee052c8d98c2253c6759ad7c247",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 44433,
                "upload_time": "2019-08-21T21:53:58",
                "url": "https://files.pythonhosted.org/packages/f7/52/6eef10d66ed89b5ca625c7708d3fc06544d6e94c57f36c7bd1a813f41126/doxytag2zealdb-0.3.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "2e87f5546ee7dc496a9aeefc8b664fad",
                    "sha256": "42f8e2218469e029a80524c2e45ff8b3da53d45fc867514f389d028c9f5bb8a3"
                },
                "downloads": -1,
                "filename": "doxytag2zealdb-0.3.1.tar.gz",
                "has_sig": true,
                "md5_digest": "2e87f5546ee7dc496a9aeefc8b664fad",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 28225,
                "upload_time": "2019-08-21T21:54:00",
                "url": "https://files.pythonhosted.org/packages/31/2a/d848482eab1eae103bf433ae2489facdc34a4b4756a8033128eefa005b7f/doxytag2zealdb-0.3.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "714160c53c6e3ca6b262f3cf5e0ce5be",
                "sha256": "a6a637219840580d5110c4d5491f522d676e62ebbe05a7eb86ce6e89f45b4529"
            },
            "downloads": -1,
            "filename": "doxytag2zealdb-0.3.1-py2-none-any.whl",
            "has_sig": true,
            "md5_digest": "714160c53c6e3ca6b262f3cf5e0ce5be",
            "packagetype": "bdist_wheel",
            "python_version": "py2",
            "requires_python": null,
            "size": 44433,
            "upload_time": "2019-08-21T21:53:56",
            "url": "https://files.pythonhosted.org/packages/f4/ad/bdafe421a11de83490c2609d6cb919f2851b17f958d35061a4cef6be05b2/doxytag2zealdb-0.3.1-py2-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "d9455ee052c8d98c2253c6759ad7c247",
                "sha256": "fd731ee85e8087ef119900a8997afc988ccd66aebe175528cf6f01aa6663c955"
            },
            "downloads": -1,
            "filename": "doxytag2zealdb-0.3.1-py3-none-any.whl",
            "has_sig": true,
            "md5_digest": "d9455ee052c8d98c2253c6759ad7c247",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 44433,
            "upload_time": "2019-08-21T21:53:58",
            "url": "https://files.pythonhosted.org/packages/f7/52/6eef10d66ed89b5ca625c7708d3fc06544d6e94c57f36c7bd1a813f41126/doxytag2zealdb-0.3.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "2e87f5546ee7dc496a9aeefc8b664fad",
                "sha256": "42f8e2218469e029a80524c2e45ff8b3da53d45fc867514f389d028c9f5bb8a3"
            },
            "downloads": -1,
            "filename": "doxytag2zealdb-0.3.1.tar.gz",
            "has_sig": true,
            "md5_digest": "2e87f5546ee7dc496a9aeefc8b664fad",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 28225,
            "upload_time": "2019-08-21T21:54:00",
            "url": "https://files.pythonhosted.org/packages/31/2a/d848482eab1eae103bf433ae2489facdc34a4b4756a8033128eefa005b7f/doxytag2zealdb-0.3.1.tar.gz"
        }
    ]
}