{ "info": { "author": "Kitware", "author_email": "", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Documentation", "Topic :: Utilities" ], "description": "# Sphinx Domain for Modern CMake\n\nThis is taken directly from the Kitware git repository's Utilities directory.\nThe original [sphinxcontrib-cmakedomain] has not been touched in quite some and\nas a result it wildly out of date. Documenting CMake domain entities in\nprojects is painful otherwise. This works *exactly* in the same way as Kitware,\nso some time might be needed to study their approach to these problems.\n\nThis repository is under the same License as all of CMake, which is the\nBSD-3-Clause license.\n\nI will do my best to keep this module in sync with the one that Kitware uses\nthemselves.\n\n\ud83d\udea8\ud83d\udea8\ud83d\udea8\nAny issues you run into with this plugin must be reported to [Kitware]\n\ud83d\udea8\ud83d\udea8\ud83d\udea8\n\n*I will* \u26d4**not**\u26d4 _make any effort to modify the module, **only**_\n\ud83d\udce6*packaging*\ud83d\udce6 *improvements.*\n\n# Installation\n\n## PyPI\n\nThis domain is available via PyPI. Install it directly via `pip`:\n\n```\n$ pip install sphinxcontrib-moderncmakedomain\n```\n\nAlternatively, place it inside of your `setup.py`, `pyproject.toml`,\n`requirements.txt` or whatever system it is that you use to declare and manage\nyour dependencies. The version available will be in the same *major* version as\nthe latest CMake release.\n\n## Git\n\nThis module is installable via `pip` and GitHub directly as well\n\n```\n$ pip install git+https://github.com/slurps-mad-rips/moderncmakedomain.git\n```\n\n# Usage\n\nTo enable the use of the `moderncmakedomain`, add\n`sphinxcontrib.moderncmakedomain` to the `extensions` variable of your\n`conf.py` file:\n\n```python\nextensions = [..., 'sphinxcontrib.moderncmakedomain', ...]\n```\n\nThe plugin currently provides several directives and refrences. These are\ndocumented below.\n\n## Directives\n\n| directive | description |\n|:------------------:|:----------------------------------------------------|\n| `cmake:variable::` | For a basic variable |\n| `cmake:command::` | For a function |\n| `cmake-module::` | Autodoc style extractor (takes a relative filepath) |\n| `cmake:envvar::` | For environment variables |\n\nTo declare any of the references found below, they must be placed into a\ndirectory with the same name under the sphinx SOURCEDIR/master doc. Thus,\n`prop_tgt/MY_PERSONAL_PROPERTY.rst` can be referred to with\n``:prop_tgt:`MY_PERSONAL_PROPERTY` ``. This is currently the *only* way CMake\npermits declaring new properties. \n\n## References\n\nEach reference below can be placed into a directory with the same name to\ndocument custom extensions provided by your CMake libraries.\n\n| ref | description |\n|:--------------:|:---------------------------------------------------|\n| `:variable:` | Refer to a CMake variable |\n| `:command:` | Refer to a CMake command |\n| `:envvar:` | Refers to an environment variable |\n| `:cpack_gen:` | Refers to CPack generators |\n| `:generator:` | Refers to a build file generator |\n| `:manual:` | Used to refer to a \"manual\" page (like `cmake(1)`) |\n| `:policy:` | Refers to CMake Policies |\n| `:module:` | Refers to CMake Modules |\n| `:prop_tgt:` | For target properties |\n| `:prop_test:` | For test properties |\n| `:prop_sf:` | For source file properties |\n| `:prop_gbl:` | For global properties |\n| `:prop_dir:` | For directory properties |\n| `:prop_inst:` | For installed file properties |\n| `:prop_cache:` | For cache properties |\n\n[sphinxcontrib-cmakedomain]: https://github.com/sphinx-contrib/cmakedomain\n[Kitware]: https://gitlab.kitware.com/\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/slurps-mad-rips/moderncmakedomain", "keywords": "sphinxcontrib,documentation,kitware,sphinx,cmake", "license": "BSD-3-Clause", "maintainer": "Isabella Muerte", "maintainer_email": "", "name": "sphinxcontrib-moderncmakedomain", "package_url": "https://pypi.org/project/sphinxcontrib-moderncmakedomain/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-moderncmakedomain/", "project_urls": { "Homepage": "https://github.com/slurps-mad-rips/moderncmakedomain" }, "release_url": "https://pypi.org/project/sphinxcontrib-moderncmakedomain/3.13/", "requires_dist": null, "requires_python": "", "summary": "Sphinx Domain for Modern CMake", "version": "3.13" }, "last_serial": 4817118, "releases": { "3.12": [ { "comment_text": "", "digests": { "md5": "1ef94e931b9a30b8eabf80f226073461", "sha256": "f9c012f8c71c8c11b0a68c16e9d7d6a55c396cc9aeeec005c97102dd6855c896" }, "downloads": -1, "filename": "sphinxcontrib_moderncmakedomain-3.12-py3-none-any.whl", "has_sig": false, "md5_digest": "1ef94e931b9a30b8eabf80f226073461", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9865, "upload_time": "2018-10-14T07:36:31", "url": "https://files.pythonhosted.org/packages/be/c8/840781883a4da2a56fd48498a32bf4e1bfe02f4608f4d84622f59e618449/sphinxcontrib_moderncmakedomain-3.12-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5a5972dce6d85a0c8471728ddd2a5a16", "sha256": "8a62cab1d7b59cffd6859e0ad694a3e8e6f93e24f38ac4fb41f3d292766305b7" }, "downloads": -1, "filename": "sphinxcontrib-moderncmakedomain-3.12.tar.gz", "has_sig": false, "md5_digest": "5a5972dce6d85a0c8471728ddd2a5a16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8204, "upload_time": "2018-10-14T07:36:32", "url": "https://files.pythonhosted.org/packages/91/4c/af87c7ee065b35cebfee385d1b6c4cbc729bcfd23720069e4990b9150191/sphinxcontrib-moderncmakedomain-3.12.tar.gz" } ], "3.12.1": [ { "comment_text": "", "digests": { "md5": "e65eab3d9e9f597c8600dfefdd0bef3d", "sha256": "c92464a6baf0a3698fb4350466b5cbb4c577b71d4e54c3d61386c15747a81973" }, "downloads": -1, "filename": "sphinxcontrib_moderncmakedomain-3.12.1-py3-none-any.whl", "has_sig": false, "md5_digest": "e65eab3d9e9f597c8600dfefdd0bef3d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9901, "upload_time": "2018-10-14T07:43:49", "url": "https://files.pythonhosted.org/packages/c8/2d/491da7f435cc96100b4f33f18266b9ba9fad0be592e0a1247d8c4874b95d/sphinxcontrib_moderncmakedomain-3.12.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c82f99268603dc128fddc2e61af49f82", "sha256": "04bd60340d76ccf74078d47fcfec9e8f3333b6ff411cac1c2b5e7cc0e65580eb" }, "downloads": -1, "filename": "sphinxcontrib-moderncmakedomain-3.12.1.tar.gz", "has_sig": false, "md5_digest": "c82f99268603dc128fddc2e61af49f82", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8251, "upload_time": "2018-10-14T07:43:50", "url": "https://files.pythonhosted.org/packages/ba/06/c0fce8dcd2ad59f181c34404727de703d7bc9ecc396a1a3e6a34339abd25/sphinxcontrib-moderncmakedomain-3.12.1.tar.gz" } ], "3.13": [ { "comment_text": "", "digests": { "md5": "b675161a379651fcd708e1ebb2cfd49b", "sha256": "56f55292c7e45881d34e68544335a79aa200f97809039e333698da5a4fb7e6b4" }, "downloads": -1, "filename": "sphinxcontrib_moderncmakedomain-3.13-py3-none-any.whl", "has_sig": false, "md5_digest": "b675161a379651fcd708e1ebb2cfd49b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11454, "upload_time": "2018-11-24T09:02:26", "url": "https://files.pythonhosted.org/packages/01/47/bd510a0a91b109f6e50602987a168b9fad472819990c5cee6d68eacb8e2c/sphinxcontrib_moderncmakedomain-3.13-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a85228b61afab8bfcac4e35c337104da", "sha256": "3c1432139a41f326990aac5078c13193888ca45ad075cd629b0c9969edeb0b5a" }, "downloads": -1, "filename": "sphinxcontrib-moderncmakedomain-3.13.tar.gz", "has_sig": false, "md5_digest": "a85228b61afab8bfcac4e35c337104da", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9476, "upload_time": "2018-11-24T09:02:27", "url": "https://files.pythonhosted.org/packages/24/ae/d33c7c5ee54e4017c723646815ff7ffffc4aaaaff80b1d63543d037f8cbb/sphinxcontrib-moderncmakedomain-3.13.tar.gz" } ], "3.14rc1": [ { "comment_text": "", "digests": { "md5": "6aa259ad0e36d363746a9313ca8fdbe5", "sha256": "11c039cfea039405111315dda4f76cb6bab4483f9cfd21f9eb2c608825d6b0b7" }, "downloads": -1, "filename": "sphinxcontrib_moderncmakedomain-3.14rc1-py3-none-any.whl", "has_sig": false, "md5_digest": "6aa259ad0e36d363746a9313ca8fdbe5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11610, "upload_time": "2019-02-13T19:27:56", "url": "https://files.pythonhosted.org/packages/94/27/dd4f8651c41e4d369e52169919a05b3a6efc4afc87f8cc61741faeb66655/sphinxcontrib_moderncmakedomain-3.14rc1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6253be92ac7ebc5eb38c96b25337c8c5", "sha256": "4ee91b8ac7252b011d29317677405dd194b9d672c6d770be488e9382a3c26daa" }, "downloads": -1, "filename": "sphinxcontrib-moderncmakedomain-3.14rc1.tar.gz", "has_sig": false, "md5_digest": "6253be92ac7ebc5eb38c96b25337c8c5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9727, "upload_time": "2019-02-13T19:27:58", "url": "https://files.pythonhosted.org/packages/42/84/ea3780abec53ac4f2ab72b81b9da9e01494f2dee91af5c37e119ccc38f57/sphinxcontrib-moderncmakedomain-3.14rc1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b675161a379651fcd708e1ebb2cfd49b", "sha256": "56f55292c7e45881d34e68544335a79aa200f97809039e333698da5a4fb7e6b4" }, "downloads": -1, "filename": "sphinxcontrib_moderncmakedomain-3.13-py3-none-any.whl", "has_sig": false, "md5_digest": "b675161a379651fcd708e1ebb2cfd49b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11454, "upload_time": "2018-11-24T09:02:26", "url": "https://files.pythonhosted.org/packages/01/47/bd510a0a91b109f6e50602987a168b9fad472819990c5cee6d68eacb8e2c/sphinxcontrib_moderncmakedomain-3.13-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a85228b61afab8bfcac4e35c337104da", "sha256": "3c1432139a41f326990aac5078c13193888ca45ad075cd629b0c9969edeb0b5a" }, "downloads": -1, "filename": "sphinxcontrib-moderncmakedomain-3.13.tar.gz", "has_sig": false, "md5_digest": "a85228b61afab8bfcac4e35c337104da", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9476, "upload_time": "2018-11-24T09:02:27", "url": "https://files.pythonhosted.org/packages/24/ae/d33c7c5ee54e4017c723646815ff7ffffc4aaaaff80b1d63543d037f8cbb/sphinxcontrib-moderncmakedomain-3.13.tar.gz" } ] }