Name | comfyui-embedded-docs JSON |
Version |
0.1.1
JSON |
| download |
home_page | None |
Summary | Embedded documentation for ComfyUI nodes |
upload_time | 2025-05-25 00:12:34 |
maintainer | None |
docs_url | None |
author | Comfy-Org |
requires_python | >=3.9 |
license | None |
keywords |
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# comfyui_embedded_docs
## Updating Documentation
Documentation files are stored in the `docs/` directory. Each node has its own subdirectory containing:
- `en.md` - English documentation
- `assets/` - Images and other assets used in the documentation
To update documentation, simply add or edit the relevant markdown files in the `docs/` directory.
## Publishing
The package is automatically published to PyPI when:
1. You manually trigger the workflow (Actions → Publish to PyPI → Run workflow)
2. You push changes to `pyproject.toml` on the main branch
3. A pull request that modifies `pyproject.toml` is merged to main
The publishing workflow:
1. Copies documentation from `docs/` to `comfyui_embedded_docs/docs/`
2. Builds the package using `python -m build`
3. Publishes to PyPI using the configured PYPI_TOKEN secret
Raw data
{
"_id": null,
"home_page": null,
"name": "comfyui-embedded-docs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Comfy-Org",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/31/6d/954eb7aa45206462a775130748c606f61ba986d89449fdfac564c178f1a2/comfyui_embedded_docs-0.1.1.tar.gz",
"platform": null,
"description": "# comfyui_embedded_docs\n\n## Updating Documentation\n\nDocumentation files are stored in the `docs/` directory. Each node has its own subdirectory containing:\n- `en.md` - English documentation\n- `assets/` - Images and other assets used in the documentation\n\nTo update documentation, simply add or edit the relevant markdown files in the `docs/` directory.\n\n## Publishing\n\nThe package is automatically published to PyPI when:\n1. You manually trigger the workflow (Actions \u2192 Publish to PyPI \u2192 Run workflow)\n2. You push changes to `pyproject.toml` on the main branch\n3. A pull request that modifies `pyproject.toml` is merged to main\n\nThe publishing workflow:\n1. Copies documentation from `docs/` to `comfyui_embedded_docs/docs/`\n2. Builds the package using `python -m build`\n3. Publishes to PyPI using the configured PYPI_TOKEN secret\n",
"bugtrack_url": null,
"license": null,
"summary": "Embedded documentation for ComfyUI nodes",
"version": "0.1.1",
"project_urls": {
"repository": "https://github.com/Comfy-Org/embedded-docs"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ae77c10b3ef190aeb54cc4b23c7640733522c8d207dde04b33e39d4c233ea81d",
"md5": "016c74925bafa6945e3c69a4c1f65fe6",
"sha256": "0da100656ee2da48b088e6f829ef624935f36026e3c45a05feeb9f85a0f4bbd8"
},
"downloads": -1,
"filename": "comfyui_embedded_docs-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "016c74925bafa6945e3c69a4c1f65fe6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 81006,
"upload_time": "2025-05-25T00:12:32",
"upload_time_iso_8601": "2025-05-25T00:12:32.852966Z",
"url": "https://files.pythonhosted.org/packages/ae/77/c10b3ef190aeb54cc4b23c7640733522c8d207dde04b33e39d4c233ea81d/comfyui_embedded_docs-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "316d954eb7aa45206462a775130748c606f61ba986d89449fdfac564c178f1a2",
"md5": "1dd4ad057e2b439aeaf6a5bbad27ea20",
"sha256": "84853e0d14088ceb760e5242e4aa0dd4e52abe3b773b3afab10157624658975f"
},
"downloads": -1,
"filename": "comfyui_embedded_docs-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "1dd4ad057e2b439aeaf6a5bbad27ea20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 82831,
"upload_time": "2025-05-25T00:12:34",
"upload_time_iso_8601": "2025-05-25T00:12:34.320707Z",
"url": "https://files.pythonhosted.org/packages/31/6d/954eb7aa45206462a775130748c606f61ba986d89449fdfac564c178f1a2/comfyui_embedded_docs-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-05-25 00:12:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Comfy-Org",
"github_project": "embedded-docs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "comfyui-embedded-docs"
}