{
    "info": {
        "author": "Galarzaa90",
        "author_email": "allan.galarza@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: C#",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3 :: Only",
            "Topic :: Documentation",
            "Topic :: Software Development :: Documentation",
            "Topic :: Text Processing :: Markup :: XML"
        ],
        "description": "\nmarkdowndotnet\n==============\n\nPython command line tool to generate markdown documents from C# Library files and their XML documentation.\n\n\n.. image:: https://img.shields.io/badge/python-3.6-yellow.svg\n   :target: https://img.shields.io/badge/python-3.6-yellow.svg\n   :alt: Python version\n \n.. image:: https://travis-ci.org/Galarzaa90/markdowndotnet.svg?branch=master\n   :target: https://travis-ci.org/Galarzaa90/markdowndotnet\n   :alt: Build Status\n  \n.. image:: https://img.shields.io/pypi/v/markdowndotnet.svg\n   :target: https://pypi.python.org/pypi/markdowndotnet/\n   :alt: PyPI\n\n\nRequirements\n------------\n\n\n* Python 3.6 or higher\n* `pythonnet <https://github.com/pythonnet/pythonnet>`_\n* `PyYAML <https://github.com/yaml/pyyaml>`_\n* `click <https://github.com/pallets/click>`_\n\nThe generated files markdown files are meant to be used with `mkdocs <https://github.com/mkdocs/mkdocs>`_ \n(with the `material theme <https://github.com/squidfunk/mkdocs-material>`_\\ ), but may be compatible with other site generators.\n\nHow to use\n----------\n\nThe script requires setting the ``DocumentationFile`` setting in the project's configuration, e.g.\n\n.. code-block:: xml\n\n   <DocumentationFile>bin\\Debug\\ExampleProject.xml</DocumentationFile>\n\nOnce this has been set, an XML file will be built along with the library's dll file.\n\nNow, when running the script, the path to the dll and the xml file must be specified:\n\n.. code-block:: shell\n\n   python markdowndotnet.py ExampleProject.dll ExampleProject.xml\n\nBy default, the files will be generated in a folder named ``output/`` in the working directory.\n\nThis contains markdown files generated for each object found in the assembly, ordered in directories by namespace. Aditionally, a file named ``index.yml`` is created, which can be appened to a ``mkdocs.yml`` file to use with `mkdocs <https://github.com/mkdocs/mkdocs>`_.\n\nFeatures\n--------\n\n\n* Generates markdown documents from a compiled binary (dll) and it's documentation file.\n* Displays all public fields, properties and methods, along with their parameters and return types.\n* Generate internal links between members\n* External links to system classes\n* Partial support for summary, params and returns tags.\n\nPlanned features\n----------------\n\n\n* Support for all XML tags\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/Galarzaa90/markdowndotnet",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "markdowndotnet",
        "package_url": "https://pypi.org/project/markdowndotnet/",
        "platform": "",
        "project_url": "https://pypi.org/project/markdowndotnet/",
        "project_urls": {
            "Homepage": "https://github.com/Galarzaa90/markdowndotnet"
        },
        "release_url": "https://pypi.org/project/markdowndotnet/0.1.0a2/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A Python markdown generator for C# libraries documentation.",
        "version": "0.1.0a2"
    },
    "last_serial": 3753196,
    "releases": {
        "0.1.0a1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b3fdf5b5ea07b62e8e431dfbf92bdea0",
                    "sha256": "142b77577048de107f6e2331d7c7b85ed6f221c4c53607e7d893e35b5797f98a"
                },
                "downloads": -1,
                "filename": "markdowndotnet-0.1.0a1.tar.gz",
                "has_sig": false,
                "md5_digest": "b3fdf5b5ea07b62e8e431dfbf92bdea0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8762,
                "upload_time": "2018-04-07T05:21:09",
                "url": "https://files.pythonhosted.org/packages/4f/1c/11890460439794e960dc71657453db221f3c0ab0ead83da4ac1253cc55f6/markdowndotnet-0.1.0a1.tar.gz"
            }
        ],
        "0.1.0a2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "f5f95670e3eee0990d598905952feaa7",
                    "sha256": "19280fd86c80513878071e576d02084433eb53dfe374e2eb448599f1b5d60135"
                },
                "downloads": -1,
                "filename": "markdowndotnet-0.1.0a2.tar.gz",
                "has_sig": false,
                "md5_digest": "f5f95670e3eee0990d598905952feaa7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9082,
                "upload_time": "2018-04-10T18:44:51",
                "url": "https://files.pythonhosted.org/packages/97/25/3f0815ebe60f8a8b71ea610e3e65ca1465d163ba4175d1127e52fb656200/markdowndotnet-0.1.0a2.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f5f95670e3eee0990d598905952feaa7",
                "sha256": "19280fd86c80513878071e576d02084433eb53dfe374e2eb448599f1b5d60135"
            },
            "downloads": -1,
            "filename": "markdowndotnet-0.1.0a2.tar.gz",
            "has_sig": false,
            "md5_digest": "f5f95670e3eee0990d598905952feaa7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 9082,
            "upload_time": "2018-04-10T18:44:51",
            "url": "https://files.pythonhosted.org/packages/97/25/3f0815ebe60f8a8b71ea610e3e65ca1465d163ba4175d1127e52fb656200/markdowndotnet-0.1.0a2.tar.gz"
        }
    ]
}