Jet Huang
a47f110fcb
Add .github/workflows/docs.yml new GitHub Actions workflow running mkdocs gh-deploy --force on every push to main. Workflow installs doc dependencies via pip on ubuntu-latest Python 3.11 and deploys the built site to the gh-pages branch, which GitHub Pages serves from the subdomain https://jetthuangai.github.io/ComfyUI-JH-PixelPro/. Create mkdocs.yml with stock mkdocs-material theme (palette=slate + indigo + features navigation.tabs + navigation.sections + navigation.top + content.code.copy + search.suggest + search.highlight), plugins=[search, mermaid2], and explicit nav with homepage + 7 category stubs + 3 flagship node pages. Homepage docs/index.md with H1 pack name + hero paragraph + Install via ComfyUI Manager quickstart + 32-node count + badge row (CI, Docs, Python, License). Category stubs docs/categories/{color, compositing, filters, mask, geometry, face, looks}.md each bulleted node list with N-xx Node Name - 1-line description + flagship page links. Flagship pages docs/nodes/n29-alpha-matte-extractor.md + n33-mask-edge-smoother.md + n10-face-detect.md each with H1 + 1-paragraph algorithm note + schema table (input/output/widget type + default + description) + embedded PNG/GIF screenshot + link to pack workflow JSON. Assets docs/assets/node-screenshots/{N-29.png, N-33.gif, N-10.png} copied (not symlinked) from pack workflows/ to avoid cross-OS git symlink issues. pyproject.toml [project.optional-dependencies] docs entry separate from dev so CI Batch-13 workflow does not pull mkdocs-material unnecessarily. Add tool.setuptools py-modules=[] so editable installs work cleanly for pip install -e ".[docs]" on this flat-layout custom-node pack. Infra-only scope; no new tag, no version bump, no GH release. Batch-14.1+ will fill per-category remaining node pages.
37 lines
735 B
YAML
37 lines
735 B
YAML
name: Docs
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
workflow_dispatch:
|
|
|
|
concurrency:
|
|
group: docs-${{ github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
permissions:
|
|
contents: write
|
|
pages: write
|
|
|
|
jobs:
|
|
deploy:
|
|
runs-on: ubuntu-latest
|
|
env:
|
|
NO_MKDOCS_2_WARNING: "true"
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "3.11"
|
|
cache: pip
|
|
cache-dependency-path: pyproject.toml
|
|
|
|
- name: Install package + docs deps
|
|
run: |
|
|
python -m pip install --upgrade pip
|
|
pip install -e ".[docs]"
|
|
|
|
- name: Deploy docs to gh-pages
|
|
run: mkdocs gh-deploy --force --remote-branch gh-pages --remote-name origin
|