| Name | freephil-docs JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | Tool to create nice documentation of PHIL parameters |
| upload_time | 2024-11-25 21:57:16 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | GNU GPL 3 |
| keywords |
phil
freephil
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# FreePHIL docs
This package helps with creating nice documentation pages for projects, which use [(Free)PHIL](https://freephil.readthedocs.io/) to handle complex input parameters.
Currently, it can convert PHIL scope into a Markdown page. The function `phil_to_markdown` returns a string in Makdown format, it is up to user to save it where desired.
## Example
An example usage is in `test_markdown.py`.
Raw data
{
"_id": null,
"home_page": null,
"name": "freephil-docs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "phil, freephil",
"author": null,
"author_email": "Jan Str\u00e1nsk\u00fd <jan.stransky@ibt.cas.cz>",
"download_url": "https://files.pythonhosted.org/packages/51/00/c58d9086aac62db663c810da286600decaf2374bdfde747728408ca2f5ca/freephil_docs-0.1.1.tar.gz",
"platform": null,
"description": "# FreePHIL docs\n\nThis package helps with creating nice documentation pages for projects, which use [(Free)PHIL](https://freephil.readthedocs.io/) to handle complex input parameters.\n\nCurrently, it can convert PHIL scope into a Markdown page. The function `phil_to_markdown` returns a string in Makdown format, it is up to user to save it where desired.\n\n## Example\n\nAn example usage is in `test_markdown.py`.\n",
"bugtrack_url": null,
"license": "GNU GPL 3",
"summary": "Tool to create nice documentation of PHIL parameters",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"phil",
" freephil"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "358148661acc286839d2ec5d3dadfc0e96236fa711c1602f868e60df9f6d1106",
"md5": "ef79f77d451496a564bea002e008966c",
"sha256": "bb5029375c317dbf345982be888f58da3219789e4da645220577ffe7ab51cf02"
},
"downloads": -1,
"filename": "freephil_docs-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ef79f77d451496a564bea002e008966c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 14776,
"upload_time": "2024-11-25T21:57:15",
"upload_time_iso_8601": "2024-11-25T21:57:15.751789Z",
"url": "https://files.pythonhosted.org/packages/35/81/48661acc286839d2ec5d3dadfc0e96236fa711c1602f868e60df9f6d1106/freephil_docs-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5100c58d9086aac62db663c810da286600decaf2374bdfde747728408ca2f5ca",
"md5": "f15105b01135ad6da95f978e11c005f9",
"sha256": "cd3e7e7900df6479f28100a408c7bad5b6df73b7cf7cc3b29323518accddcae3"
},
"downloads": -1,
"filename": "freephil_docs-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "f15105b01135ad6da95f978e11c005f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 16199,
"upload_time": "2024-11-25T21:57:16",
"upload_time_iso_8601": "2024-11-25T21:57:16.860924Z",
"url": "https://files.pythonhosted.org/packages/51/00/c58d9086aac62db663c810da286600decaf2374bdfde747728408ca2f5ca/freephil_docs-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 21:57:16",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "freephil-docs"
}
