Registry / ai-ml / comfyui-embedded-docs

comfyui-embedded-docs

library0.4.3pypypiunverified

ComfyUI-embedded-docs is a Python package that provides offline documentation and help resources specifically for ComfyUI's core nodes. It bundles Markdown files and associated assets, making node-specific documentation accessible directly within the ComfyUI interface. The package maintains an active development status with regular updates, typically published to PyPI upon changes to its `pyproject.toml` on the main branch.

ai-ml llm-agents

pip install comfyui-embedded-docs

github ↗package ↗

INSTALL

IMPORT

SIG · COMFYUI-EMBEDDED-D

comfyui-embedded-docs

ai-mlpythonv0.4.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

After installation, launch your ComfyUI instance. To view documentation for any core node, click on the node in your workflow, then click the 'node info' icon (often a '?' or 'i' symbol) in the selection toolbox. This will open a documentation page directly within ComfyUI, providing details about the node's function, inputs, and outputs.

pip install comfyui-embedded-docs # Now, launch ComfyUI (e.g., python main.py) # Then, within the ComfyUI UI, you can access the embedded documentation.

Debug

Known issues

gotchaOutdated or missing node help documentation is a common issue if ComfyUI's core dependencies, including `comfyui-embedded-docs`, are not updated alongside the main ComfyUI application.

fix

Ensure you run a full update for your ComfyUI installation, not just a `git pull` of the main repository. This often involves updating core dependencies explicitly or using update scripts provided by ComfyUI.

affects: <0.4.3 if not updated with ComfyUI

gotchaThis package provides documentation for *core* ComfyUI nodes. If you encounter issues with custom nodes (e.g., they don't load, cause errors, or their documentation is missing/incorrect), the problem likely lies within the custom node's implementation or its own documentation, not this package.

fix

For custom node issues, consult the custom node's specific GitHub repository or support channels. Disable custom nodes to isolate problems.

affects: All

gotchaWhen contributing to the documentation or making local changes, a standard `pip install` will not reflect your modifications immediately.

fix

Use an 'editable' installation (`pip install -e /path/to/embedded-docs/`) for development. This allows changes in the source directory to be reflected in ComfyUI without reinstallation. Remember to restart or refresh ComfyUI after making changes.

affects: All

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'comfyui_embedded_docs'

The 'comfyui-embedded-docs' package or one of its required dependencies is not installed in the specific Python environment that ComfyUI is using, especially common with portable ComfyUI installations.

fix

Navigate to your ComfyUI's embedded Python directory (e.g., `ComfyUI/python_embeded`), open a terminal there, and install the package using: `./python.exe -m pip install comfyui-embedded-docs`.

ComfyUI node documentation missing

The `comfyui-embedded-docs` package or ComfyUI's core dependencies are outdated or not properly updated alongside the main ComfyUI application, preventing documentation from loading or displaying correctly.

fix

Ensure you run a full update for your ComfyUI installation, including its core dependencies. This often involves using update scripts provided by ComfyUI or explicitly running `pip install --upgrade comfyui-embedded-docs` within ComfyUI's Python environment.

ComfyUI-embedded-docs local changes not reflecting

When contributing to the documentation or making local changes, a standard `pip install` or even a non-editable `pip install -e` will not immediately reflect your modifications in ComfyUI.

fix

Use an editable installation by running `pip install -e /path/to/your/local/comfyui-embedded-docs/` from your terminal. After making changes to the source files, restart or refresh your ComfyUI instance.

Upgrade

Version history

0.4.3latest on PyPI · released Feb 24, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

37 hits · last 30 days

node

OpenAI (training)

Perplexity

Resources

githubhttps://github.com/Comfy-Org/embedded-docs ↗

packagehttps://pypi.org/project/comfyui-embedded-docs/ ↗