{
    "info": {
        "author": "Nikhil Ramakrishnan",
        "author_email": "freetype-devel@nongnu.org",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Topic :: Documentation",
            "Topic :: Text Processing"
        ],
        "description": "[![Build Status](https://travis-ci.org/freetype/docwriter.svg?branch=master)](https://travis-ci.org/freetype/docwriter)\n[![PyPI version](https://badge.fury.io/py/docwriter.svg)](https://pypi.org/project/docwriter/)\n\n# FreeType Docwriter\n\nDocwriter is an API documentation generator for the FreeType Library that extracts and builds Markdown docs from the FreeType header files.\n\n## Installation\n\nRun `pip install docwriter` (see (4) below for an automated `virtualenv` usage). It requires Python 2.7+ or 3.4+ to run.\n\n## Steps to Generate Docs\n1.  Ensure `docwriter` is installed using `pip`.\n2.  Clone the freetype2 repository from [here](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/).\n3.  The FreeType build system can be used to generate the docs:\n\n    ```\n    sh autogen.sh\n    ./configure\n    make refdoc\n    ```\n4. Alternatively, step 1 and the make target can be replaced with `make refdoc-venv`. This installs all requirements automatically in a separate virtual environment. More information on `virtualenv` usage can be found [here](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/tree/docs/reference/README).\n\n## Development Usage\n1.  Clone this repository.\n2.  Clone the freetype2 repository from [here](http://git.savannah.gnu.org/cgit/freetype/freetype2.git/).\n3.  Run `pip install -r requirements.txt` in your environment (`virtualenv` recommended).\n4.  Copy the `include/` directory from `freetype2` to `docwriter`.\n5.  Run in the `docwriter` directory:\n\n    ```bash\n\t\tpython -m docwriter                      \\\n\t\t\t--prefix=ft2                     \\\n\t\t\t--title=FreeType-2.9.1           \\\n\t\t\t--output=./docs/reference        \\\n\t\t\t./include/freetype/*.h           \\\n\t\t\t./include/freetype/config/*.h    \\\n\t\t\t./include/freetype/cache/*.h\n    ```\n6.  The markdown files should be generated in `docs/reference/markdown/`. Static site can be rendered by running `mkdocs build` in `docs/reference`. Read more about Mkdocs [here](https://www.mkdocs.org/#building-the-site).\n\n## Usage Information\n\n```\ndocwriter [-h] [-t T] -o DIR [-p PRE] [-q | -v] files [files ...]\n\nDocWriter Usage information\n\npositional arguments:\n  files                 list of source files to parse, wildcards are allowed\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -t T, --title T       set project title, as in '-t \"My Project\"'\n  -o DIR, --output DIR  set output directory, as in '-o mydir'\n  -p PRE, --prefix PRE  set documentation prefix, as in '-p ft2'\n  -q, --quiet           run quietly, show only errors\n  -v, --verbose         increase output verbosity\n```\n\n## Running Tests\n\nThere are two possible test scenarios:\n\n1. Running tests on both py27 and py36 (using tox - requires both python versions installed).\n2. Running tests on the currently installed Python version.\n\nThey are detailed below.\n\n### Test using Tox\n\nTo test on both py27 and py36:\n\n1.  Make sure `tox` is installed:\n    ```bash\n    pip install tox\n    ```\n\n2.  Ensure both py27 and py36 are available.\n\n3.  Run tests:\n    ```bash\n    tox\n    ```\n\n### Test on single python version\n\nTo test on current python version using pytest:\n\n1.  Make sure `pytest` is installed:\n    ```bash\n    pip install pytest\n    ```\n\n2.  Run tests:\n    ```bash\n    cd tests/\n    python -m pytest\n    ```\n\n## License\n\nThis library is licensed under the [FreeType License](https://www.freetype.org/license.html).\n\n## History\n\nThis library was originally written by David Turner as `docmaker` which collected and presented\ndocumentation in HTML. It has since been modified multiple times, including a major refactor\nto allow multiple output formats. The current `docwriter` is the biggest rewrite, with lots of\nchanges and additions that allow it to be more flexible, readable, maintainable and usable.\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/freetype/docwriter",
        "keywords": "freetype docwriter",
        "license": "FreeType License",
        "maintainer": "",
        "maintainer_email": "",
        "name": "docwriter",
        "package_url": "https://pypi.org/project/docwriter/",
        "platform": "",
        "project_url": "https://pypi.org/project/docwriter/",
        "project_urls": {
            "Homepage": "https://github.com/freetype/docwriter"
        },
        "release_url": "https://pypi.org/project/docwriter/1.1.1/",
        "requires_dist": [
            "mistune (==0.8.4)",
            "mkdocs (==1.0.4)",
            "mkdocs-material (==4.0.2)",
            "PyYAML (==5.1)"
        ],
        "requires_python": "",
        "summary": "API reference documentation generator for FreeType.",
        "version": "1.1.1"
    },
    "last_serial": 4940825,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "20413b0bd1e25dc7b7587ccecd7111c1",
                    "sha256": "14ae5b900d6eb0dbd7bd6397e7587966cd5b4cea9ea9805048f00a16f96b8080"
                },
                "downloads": -1,
                "filename": "docwriter-0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "20413b0bd1e25dc7b7587ccecd7111c1",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 26208,
                "upload_time": "2018-07-31T13:57:45",
                "url": "https://files.pythonhosted.org/packages/54/5b/47b096cff5d956f930238a19c1941223dec2d6d021de05239e0b26c4dc2c/docwriter-0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "fd611b8f19fa09f5d4ae2be628a4b5a3",
                    "sha256": "f2b6ca10c1ff3d36e12bb7347b77c2e13183898c4038fdfdd83c6d8ce3804941"
                },
                "downloads": -1,
                "filename": "docwriter-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "fd611b8f19fa09f5d4ae2be628a4b5a3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 22558,
                "upload_time": "2018-07-31T13:57:46",
                "url": "https://files.pythonhosted.org/packages/1c/cc/3947ea958e661427c354bb64dcb9ec84e876ba790b4fd32ee5cc415710ae/docwriter-0.1.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2e296705708ba1fb1c6f325b0bc07120",
                    "sha256": "d3a8171a9596334209503756cd23519143bcf2261d60575687e0f6f820952914"
                },
                "downloads": -1,
                "filename": "docwriter-0.2-py2-none-any.whl",
                "has_sig": false,
                "md5_digest": "2e296705708ba1fb1c6f325b0bc07120",
                "packagetype": "bdist_wheel",
                "python_version": "py2",
                "requires_python": null,
                "size": 27263,
                "upload_time": "2018-08-02T18:22:24",
                "url": "https://files.pythonhosted.org/packages/8e/a2/89695ad0a7a9cbd873eff6405d1ef8587a510890f2349ac2e5776d99780d/docwriter-0.2-py2-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "565e08851e55b6fcb5cf000c8ce48731",
                    "sha256": "9bc037b2ef61a6abd5be2d5bf2afdc38dbf33b0c297bf8422907de0c97a8e35d"
                },
                "downloads": -1,
                "filename": "docwriter-0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "565e08851e55b6fcb5cf000c8ce48731",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 27263,
                "upload_time": "2018-08-02T18:21:58",
                "url": "https://files.pythonhosted.org/packages/97/25/867535ee3d2155d94df5b44640e70487f3cabd34849327b4481af2b3cd78/docwriter-0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "44189ae21909754de839bd4c0d40f659",
                    "sha256": "536a2c85f647043bdde70fffc3bb33f8ff21f32c98e9d325cc59306617743650"
                },
                "downloads": -1,
                "filename": "docwriter-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "44189ae21909754de839bd4c0d40f659",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 62874,
                "upload_time": "2018-08-02T18:21:59",
                "url": "https://files.pythonhosted.org/packages/b9/67/7c40d43d5f3fa92607856ba0cb1e5431cffddca0f5ae485e94db23e73225/docwriter-0.2.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c7d974e561b579d9aa2ed9ed00764ab0",
                    "sha256": "67945743cd8a1680978f93f963e0c6f7cbf64b10191d428530e5e887cf4df81a"
                },
                "downloads": -1,
                "filename": "docwriter-0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c7d974e561b579d9aa2ed9ed00764ab0",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 27332,
                "upload_time": "2018-08-02T18:29:31",
                "url": "https://files.pythonhosted.org/packages/d3/4c/dfe58a03aa65c85ebb29fae7ec6ac1303598bbf1c34f136cdf1bbc14bf1d/docwriter-0.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "53d0c9b143b51eeaa8617e4c4dda957b",
                    "sha256": "707d856f43f368ced7e8a0656b722cc58bb4f1c87ba9950d234e6a6667c83667"
                },
                "downloads": -1,
                "filename": "docwriter-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "53d0c9b143b51eeaa8617e4c4dda957b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 63101,
                "upload_time": "2018-08-02T18:29:32",
                "url": "https://files.pythonhosted.org/packages/3b/e0/d8377bd02c28a428381c2fd5ec2073535e9965e0d5d42f5634898b12411a/docwriter-0.3.tar.gz"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6412defc6eda62d5084663367028f571",
                    "sha256": "d0f23c8451dd9f13a768863110310b4868a2e5e3c1b06d10d9d68f43c3f78443"
                },
                "downloads": -1,
                "filename": "docwriter-0.3.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "6412defc6eda62d5084663367028f571",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 27369,
                "upload_time": "2018-08-02T18:49:44",
                "url": "https://files.pythonhosted.org/packages/b2/44/959918bb12bb556aa240103e0776bd12349c6c8252ec98fb42b65ca9c9db/docwriter-0.3.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c0c2adc4094461615ee791808993b028",
                    "sha256": "8fca64a2d4cf3426fc55a8ea586fe1f5b7ecc73f86bbc3a44e9e8cf06ccf7b53"
                },
                "downloads": -1,
                "filename": "docwriter-0.3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "c0c2adc4094461615ee791808993b028",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 63155,
                "upload_time": "2018-08-02T18:49:44",
                "url": "https://files.pythonhosted.org/packages/5d/1a/2c6ed9658c7cd77c58b9c29c7e1d0bb4678008444e51a97d215998994754/docwriter-0.3.1.tar.gz"
            }
        ],
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8edfb6065374cad262834f8fcea92430",
                    "sha256": "9f1645522afd12438a8df8e79e61602780895d9ec7fd98a7748be9e2f5f728e1"
                },
                "downloads": -1,
                "filename": "docwriter-1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8edfb6065374cad262834f8fcea92430",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 27327,
                "upload_time": "2018-08-06T06:39:58",
                "url": "https://files.pythonhosted.org/packages/a7/63/f47945f74ed0a6cf05350fbb63645062866668c76433214baadf83b5a424/docwriter-1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "466d506be5d256aa787dd3a828efcd38",
                    "sha256": "b32c353be9822186ed03d13243dcf4fb71fbaf571cc949fad6dc1ed7f745c8e8"
                },
                "downloads": -1,
                "filename": "docwriter-1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "466d506be5d256aa787dd3a828efcd38",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 63129,
                "upload_time": "2018-08-06T06:39:59",
                "url": "https://files.pythonhosted.org/packages/87/1c/3a3b043cdc6bdb7da3230e56b2cd2dbba27c13fbc72fd15fab411931c5e9/docwriter-1.0.tar.gz"
            }
        ],
        "1.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4fbb2e40cb81cf5b0c1dea0453e90604",
                    "sha256": "6773fb860a6b80c98db1ebece04928f1f492c954c8f11d09a88c67ded893a296"
                },
                "downloads": -1,
                "filename": "docwriter-1.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "4fbb2e40cb81cf5b0c1dea0453e90604",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 27369,
                "upload_time": "2018-08-07T17:36:58",
                "url": "https://files.pythonhosted.org/packages/66/a0/86326da12ce9ac337eb1f3f6537c32f201bbbe7db597a3089ac8d4a9b12e/docwriter-1.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c86f53cbaf58f65c067d7223489c8c43",
                    "sha256": "e02333d04b191d89b7f431738181eae2b5d3efc45543bae23bc5209d46e9c978"
                },
                "downloads": -1,
                "filename": "docwriter-1.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "c86f53cbaf58f65c067d7223489c8c43",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 63218,
                "upload_time": "2018-08-07T17:36:59",
                "url": "https://files.pythonhosted.org/packages/7d/71/744199ca454593502e89848d7d310a2a87fef1ef06f859e15e56c35f47ca/docwriter-1.0.1.tar.gz"
            }
        ],
        "1.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "42b3b958346cc2ae927dd05b85317dd4",
                    "sha256": "543b5a000f7385992f7b169a48600ce621fd30348cd394e6fe7f9a6a4691fe57"
                },
                "downloads": -1,
                "filename": "docwriter-1.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "42b3b958346cc2ae927dd05b85317dd4",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 27382,
                "upload_time": "2018-09-04T06:14:05",
                "url": "https://files.pythonhosted.org/packages/0d/3c/b231a43064c407c209211abca10c0033b7d6d9fdf5f5aa7d4ed265bf8a96/docwriter-1.0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "96494beb9fc5d6f1db3a76458997f6d1",
                    "sha256": "c93191606b0e9d16291d89cba301ea2350af87c97ac4d80d39c5fa34e6b7bce5"
                },
                "downloads": -1,
                "filename": "docwriter-1.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "96494beb9fc5d6f1db3a76458997f6d1",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 63231,
                "upload_time": "2018-09-04T06:14:06",
                "url": "https://files.pythonhosted.org/packages/45/48/f184d117c68f6cc09ccbfa5c557cf21b227e6ce9a1a2926b93ec55b28892/docwriter-1.0.2.tar.gz"
            }
        ],
        "1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a11748b2432ada44c880c55e21b2bf4f",
                    "sha256": "fb81a66af244bbb423cdbd1dddf91b8e545b56affbbcc8ef43d266d4a79a5bfa"
                },
                "downloads": -1,
                "filename": "docwriter-1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a11748b2432ada44c880c55e21b2bf4f",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 27292,
                "upload_time": "2019-03-02T12:11:39",
                "url": "https://files.pythonhosted.org/packages/10/2f/2eeeb18c0eff85e5ac71e7c908df775f4f85ad7d28b3750fe2ea5ddf43af/docwriter-1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "c01b7a0d0244c0ac07eae4ce21183410",
                    "sha256": "380b026b9466b457d5eedc546b64513ec4e03930199f7337ede123ef0e2b3062"
                },
                "downloads": -1,
                "filename": "docwriter-1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "c01b7a0d0244c0ac07eae4ce21183410",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 67682,
                "upload_time": "2019-03-02T12:11:41",
                "url": "https://files.pythonhosted.org/packages/33/e8/df5eda305ae8ae4cccfbda69a0121c234027986cb7cccfe9be7641cd6e58/docwriter-1.1.tar.gz"
            }
        ],
        "1.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "062fb466c6f78911a8cfc07cb03cfa12",
                    "sha256": "a374d634370a10e13b8f69488f3ac0c7d3a98546425d3bba81b2dba21c7d9884"
                },
                "downloads": -1,
                "filename": "docwriter-1.1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "062fb466c6f78911a8cfc07cb03cfa12",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 27687,
                "upload_time": "2019-03-14T17:26:11",
                "url": "https://files.pythonhosted.org/packages/ed/52/6c344b76b792841c2d1ab19b30aae843442d61ec00ff9dcbae888b45a29b/docwriter-1.1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "b02be7127b31966f761af9798168155f",
                    "sha256": "3f9a181a63de6cda384d2fbed1daaa5b0bb4fe582a90730ef45b3ba2564c7754"
                },
                "downloads": -1,
                "filename": "docwriter-1.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "b02be7127b31966f761af9798168155f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 68687,
                "upload_time": "2019-03-14T17:26:12",
                "url": "https://files.pythonhosted.org/packages/98/ba/fdddb494fe7069f27f204f7cda26199da39652abdc6de53d6fb2b0ee126b/docwriter-1.1.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "062fb466c6f78911a8cfc07cb03cfa12",
                "sha256": "a374d634370a10e13b8f69488f3ac0c7d3a98546425d3bba81b2dba21c7d9884"
            },
            "downloads": -1,
            "filename": "docwriter-1.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "062fb466c6f78911a8cfc07cb03cfa12",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 27687,
            "upload_time": "2019-03-14T17:26:11",
            "url": "https://files.pythonhosted.org/packages/ed/52/6c344b76b792841c2d1ab19b30aae843442d61ec00ff9dcbae888b45a29b/docwriter-1.1.1-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "b02be7127b31966f761af9798168155f",
                "sha256": "3f9a181a63de6cda384d2fbed1daaa5b0bb4fe582a90730ef45b3ba2564c7754"
            },
            "downloads": -1,
            "filename": "docwriter-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b02be7127b31966f761af9798168155f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 68687,
            "upload_time": "2019-03-14T17:26:12",
            "url": "https://files.pythonhosted.org/packages/98/ba/fdddb494fe7069f27f204f7cda26199da39652abdc6de53d6fb2b0ee126b/docwriter-1.1.1.tar.gz"
        }
    ]
}