| Name | pants-backend-mdbook JSON |
| Version |
0.4.1
JSON |
| download |
| home_page | None |
| Summary | A MdBook documentation builder plugin for the Pants buildsystem. |
| upload_time | 2024-04-12 13:14:01 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT License Copyright (c) 2022 Tom Solberg Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
pantsbuild
pants
backend
mdbook
markdown
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MDBook backend for Pants
> **Warning**
> This plugin is in development. No stability is guaranteed! Contributions welcome.
This provides a tool for building mdbook targets with pants. There is currently a single very simple rule:
``` python
md_book(
name="my-docs",
sources=["book.toml", "src/*"],
)
```
| Argument | Meaning | Default value |
| --- | --- | --- |
| `name` | The target name | Same as any other target, which is the directory name |
| `sources` | Files included when building the book | `book.toml` and the `src` directory |
| `decsription` | A description of the target | `""` |
| `tags` | List of tags | `[]` |
Raw data
{
"_id": null,
"home_page": null,
"name": "pants-backend-mdbook",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "pantsbuild pants backend mdbook markdown",
"author": null,
"author_email": "Tom Solberg <me@sbg.dev>",
"download_url": "https://files.pythonhosted.org/packages/95/d3/7eb444eb9a4369819b1f24d8ebdc23e8153059cf89578c2c60d1a8c830e6/pants_backend_mdbook-0.4.1.tar.gz",
"platform": null,
"description": "# MDBook backend for Pants\n\n\n\n> **Warning**\n> This plugin is in development. No stability is guaranteed! Contributions welcome.\n\nThis provides a tool for building mdbook targets with pants. There is currently a single very simple rule:\n\n``` python\nmd_book(\n name=\"my-docs\",\n sources=[\"book.toml\", \"src/*\"],\n)\n```\n\n| Argument | Meaning | Default value |\n| --- | --- | --- |\n| `name` | The target name | Same as any other target, which is the directory name |\n| `sources` | Files included when building the book | `book.toml` and the `src` directory |\n| `decsription` | A description of the target | `\"\"` |\n| `tags` | List of tags | `[]` |\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2022 Tom Solberg Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "A MdBook documentation builder plugin for the Pants buildsystem.",
"version": "0.4.1",
"project_urls": {
"Changelog": "https://github.com/tgolsson/pants-backends/tree/main/pants-plugins/mdbook/CHANGELOG.md",
"Code": "https://github.com/tgolsson/pants-backends/tree/main/pants-plugins/mdbook",
"Repository": "https://github.com/tgolsson/pants-backends"
},
"split_keywords": [
"pantsbuild",
"pants",
"backend",
"mdbook",
"markdown"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2302b671b3e54c61fab6108d08a243c0c73504b921f688c78acedf2fd1f705e1",
"md5": "1aeaebf07374bd30879a4bcda1ba149f",
"sha256": "2d73c4de4613358fd17b1818d8cffff96740999b69a17038e8638098337d922f"
},
"downloads": -1,
"filename": "pants_backend_mdbook-0.4.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "1aeaebf07374bd30879a4bcda1ba149f",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 7960,
"upload_time": "2024-04-12T13:13:59",
"upload_time_iso_8601": "2024-04-12T13:13:59.962791Z",
"url": "https://files.pythonhosted.org/packages/23/02/b671b3e54c61fab6108d08a243c0c73504b921f688c78acedf2fd1f705e1/pants_backend_mdbook-0.4.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95d37eb444eb9a4369819b1f24d8ebdc23e8153059cf89578c2c60d1a8c830e6",
"md5": "9ce6636b51d88d802334e7ad86c4e9cf",
"sha256": "a0f4336b35922d20744064b1ca00b4cf116057918d92e86795fa426030743f73"
},
"downloads": -1,
"filename": "pants_backend_mdbook-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "9ce6636b51d88d802334e7ad86c4e9cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4808,
"upload_time": "2024-04-12T13:14:01",
"upload_time_iso_8601": "2024-04-12T13:14:01.379463Z",
"url": "https://files.pythonhosted.org/packages/95/d3/7eb444eb9a4369819b1f24d8ebdc23e8153059cf89578c2c60d1a8c830e6/pants_backend_mdbook-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-12 13:14:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tgolsson",
"github_project": "pants-backends",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pants-backend-mdbook"
}
