Skip to content

Commit

Permalink
Merge pull request #36 from Visionatrix/mkdocs
Browse files Browse the repository at this point in the history
docs from Sphinx to MkDocs
bigcat88 authored Sep 14, 2024
2 parents c4b1797 + 2dc7eba commit cb9a3d3
Showing 82 changed files with 1,995 additions and 5,377 deletions.
5 changes: 2 additions & 3 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
@@ -18,6 +18,5 @@ jobs:
- name: Install Docs dependencies
run: python3 -m pip install -r requirements.txt

- name: Build and push Docs
run: |
make html SPHINXOPTS="-W"
- name: Build Docs
run: mkdocs build --strict
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -50,11 +50,11 @@ jobs:
- name: Build and push Docs
run: |
export CHANGES_DATE=`date -d"@$(git log -1 --pretty=%ct)" --iso-8601=seconds`
make html
mkdocs build
git config --global user.name bigcat88
git config --global user.email "bigcat88@users.noreply.github.com"
docroot=`mktemp -d`
rsync -av "docs/_build/html/" "${docroot}/"
rsync -av "site/" "${docroot}/"
rsync -av "flows_publish/" "${docroot}/"
rsync -av "models_catalog.json" "${docroot}/"
rsync -av "docs/swagger-ui/" "${docroot}/swagger-ui/"
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -103,3 +103,5 @@ scripts/visionatrix
tasks_history.db
/flows.zip
flows_publish
hardware_results/
site/
13 changes: 0 additions & 13 deletions Makefile

This file was deleted.

17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -8,12 +8,13 @@ For any problems with Visionatrix or suggestions for improvement, go to the [mai

- [Documentation](https://visionatrix.github.io/VixFlowsDocs/)
- [Available Flows](https://visionatrix.github.io/VixFlowsDocs/Flows/index.html)
- [Manual Installation](https://visionatrix.github.io/VixFlowsDocs/Installation.html)
- [Command Line Options](https://visionatrix.github.io/VixFlowsDocs/CommandLineOptions.html)
- [Working modes](https://visionatrix.github.io/VixFlowsDocs/WorkingModes.html)
- [Vix Workflows](https://visionatrix.github.io/VixFlowsDocs/VixWorkflows.html)
- [Creating Workflows](https://visionatrix.github.io/VixFlowsDocs/ComfyUI2VixMigration.html)
- [Technical information](https://visionatrix.github.io/VixFlowsDocs/TechnicalInformation.html)
- [FAQ](https://visionatrix.github.io/VixFlowsDocs/FAQ.html)
- [Hardware FAQ](https://visionatrix.github.io/VixFlowsDocs/HardwareFAQ.html)
- [Manual Installation](https://visionatrix.github.io/VixFlowsDocs/installation.html)
- [Command Line Options](https://visionatrix.github.io/VixFlowsDocs/command_line_options.html)
- [Working modes](https://visionatrix.github.io/VixFlowsDocs/working_modes.html)
- [Vix Workflows](https://visionatrix.github.io/VixFlowsDocs/vix_workflows.html)
- [Creating Workflows](https://visionatrix.github.io/VixFlowsDocs/comfyui_vix_migration.html)
- [Technical information](https://visionatrix.github.io/VixFlowsDocs/technical_information.html)
- [FAQ](https://visionatrix.github.io/VixFlowsDocs/faq.html)
- [Hardware FAQ](https://visionatrix.github.io/VixFlowsDocs/hardware_faq.html)
- [Hardware Results](https://visionatrix.github.io/VixFlowsDocs/hardware_results.html)
- [OpenAPI](https://visionatrix.github.io/VixFlowsDocs/swagger.html)
105 changes: 0 additions & 105 deletions docs/ComfyUI2VixMigration.rst

This file was deleted.

105 changes: 0 additions & 105 deletions docs/CommandLineOptions.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/FAQ.rst

This file was deleted.

33 changes: 33 additions & 0 deletions docs/Flows/Colorful_XL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Colorful XL

A fairly simple flow at the moment, simply using the latest **Colorful XL** model without any post-processing.

!!! warning

**Not Safe for Work (NSFW) version.**

**Supports various aspect ratios.**

**Supports fast generation using the Align Steps technique**

## Examples

![Image](../FlowsResults/Colorful_XL_1.png)

portrait, half-robot woman, in the dark, contrasting light, realistic, masterpiece

---

![Image](../FlowsResults/Colorful_XL_2.png)

half-cat woman, in the forest, vivid lights, realistic, masterpiece

- Fast Run: true, Vibrancy: 3

---

![Image](../FlowsResults/Colorful_XL_3.png)

portrait, young man, angel, sky, sun, high contrast

- Fast Run: true, Vibrancy: 2, Steps number to generate: 60
38 changes: 0 additions & 38 deletions docs/Flows/Colorful_XL.rst

This file was deleted.

21 changes: 21 additions & 0 deletions docs/Flows/ComicuPortrait.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# ComicU Anime Portrait

Create an anime(sketch by default) image from a photo of a person.

**Prompt** is optional, something like emotions can be used there: *smile, sad, serious, etc*.

> *If you ticked the "Disable Simple style" you can try to add something like* **line-sketch** *to the prompt.*
Part of the flow runs on the CPU, part on the GPU, the flow is quite fast and convenient for everyday use.

## Examples

> As input files, the photos of `Bruce Lee` and `Shakira` were taken from the Internet and used.
![Image](../FlowsResults/ComicuPortrait_1.png)

![Image](../FlowsResults/ComicuPortrait_2.png)

![Image](../FlowsResults/ComicuPortrait_3.png)

![Image](../FlowsResults/ComicuPortrait_4.png)
Loading

0 comments on commit cb9a3d3

Please sign in to comment.