docs: adds docs tool, material for mkdocs, along with more fleshed ou…

…t docstrings. this includes ability to serve up a local docs website.
brycedrennan · Jan 3, 2024 · 4c174ad · 4c174ad
1 parent f84406f
commit 4c174ad
Show file tree

Hide file tree

Showing 56 changed files with 704 additions and 7 deletions.
diff --git a/Makefile b/Makefile
@@ -88,6 +88,11 @@ require_pyenv:
 	  echo -e "\033[0;32m ✔️  pyenv-virtualenv installed\033[0m";\
 	fi
 
+.PHONY: docs
+
+docs:
+	mkdocs serve
+
 update-stablestudio:
 	@echo "Updating stablestudio"
 	cd ../imaginAIry-StableStudio && \

diff --git a/...00005_1_ddim50_PS7.5_wide_shot_of_sun_setting_on_a_green_valley_[generated].jpg b/...00005_1_ddim50_PS7.5_wide_shot_of_sun_setting_on_a_green_valley_[generated].jpg
diff --git a/docs/assets/000032_337692011_PLMS40_PS7.5_a_photo_of_a_dog.jpg b/docs/assets/000032_337692011_PLMS40_PS7.5_a_photo_of_a_dog.jpg
diff --git a/docs/assets/000078_260972468_PLMS40_PS7.5_portrait_photo_of_a_freckled_woman.jpg b/docs/assets/000078_260972468_PLMS40_PS7.5_portrait_photo_of_a_freckled_woman.jpg
diff --git a/docs/assets/013986_1_kdpmpp2m59_PS7.5_a_bluejay_[generated].jpg b/docs/assets/013986_1_kdpmpp2m59_PS7.5_a_bluejay_[generated].jpg
diff --git a/docs/assets/026882_1_ddim50_PS7.5_a_scenic_landscape_[generated].jpg b/docs/assets/026882_1_ddim50_PS7.5_a_scenic_landscape_[generated].jpg
diff --git a/docs/assets/026884_1_ddim50_PS7.5_photo_of_a_dog_[generated].jpg b/docs/assets/026884_1_ddim50_PS7.5_photo_of_a_dog_[generated].jpg
diff --git a/docs/assets/026885_1_ddim50_PS7.5_girl_with_a_pearl_earring_[generated].jpg b/docs/assets/026885_1_ddim50_PS7.5_girl_with_a_pearl_earring_[generated].jpg
diff --git a/...sets/026890_1_ddim50_PS7.5_photo_of_a_bowl_of_fruit._still_life_[generated].jpg b/...sets/026890_1_ddim50_PS7.5_photo_of_a_bowl_of_fruit._still_life_[generated].jpg
diff --git a/docs/assets/026891_1_ddim50_PS7.5_close-up_photo_of_a_bluejay_[generated].jpg b/docs/assets/026891_1_ddim50_PS7.5_close-up_photo_of_a_bluejay_[generated].jpg
diff --git a/docs/assets/026893_1_ddim50_PS7.5_macro_photo_of_a_flower_[generated].jpg b/docs/assets/026893_1_ddim50_PS7.5_macro_photo_of_a_flower_[generated].jpg
diff --git a/docs/assets/bird-normal-generated.jpg b/docs/assets/bird-normal-generated.jpg
diff --git a/docs/assets/bird-normal.jpg b/docs/assets/bird-normal.jpg
diff --git a/docs/assets/dog-hed-boundary-dalmation.jpg b/docs/assets/dog-hed-boundary-dalmation.jpg
diff --git a/docs/assets/dog-hed-boundary.jpg b/docs/assets/dog-hed-boundary.jpg
diff --git a/docs/assets/fancy-living-depth-generated.jpg b/docs/assets/fancy-living-depth-generated.jpg
diff --git a/docs/assets/fancy-living-depth.jpg b/docs/assets/fancy-living-depth.jpg
diff --git a/docs/assets/fancy-living.jpg b/docs/assets/fancy-living.jpg
diff --git a/docs/assets/girl_with_a_pearl_earring.jpg b/docs/assets/girl_with_a_pearl_earring.jpg
diff --git a/docs/assets/indiana-pose-polar-bear.jpg b/docs/assets/indiana-pose-polar-bear.jpg
diff --git a/docs/assets/indiana-pose.jpg b/docs/assets/indiana-pose.jpg
diff --git a/docs/assets/indiana.jpg b/docs/assets/indiana.jpg
diff --git a/docs/assets/lena-canny-generated.jpg b/docs/assets/lena-canny-generated.jpg
diff --git a/docs/assets/lena-canny.jpg b/docs/assets/lena-canny.jpg
diff --git a/docs/assets/lena.png b/docs/assets/lena.png
diff --git a/docs/assets/pearl-gray.jpg b/docs/assets/pearl-gray.jpg
diff --git a/docs/assets/pearl-recolor-a.jpg b/docs/assets/pearl-recolor-a.jpg
diff --git a/...ts/pearl_anime_019537_521829407_kdpmpp2m30_PS9.0_img2img-0.01_make_it_anime.jpg b/...ts/pearl_anime_019537_521829407_kdpmpp2m30_PS9.0_img2img-0.01_make_it_anime.jpg
diff --git a/...l_beach_019561_862735879_kdpmpp2m30_PS7.0_img2img-0.01_make_it_at_the_beach.jpg b/...l_beach_019561_862735879_kdpmpp2m30_PS7.0_img2img-0.01_make_it_at_the_beach.jpg
diff --git a/docs/assets/pearl_shuffle_019331_1_kdpmpp2m15_PS7.5_img2img-0.0_a_clown.jpg b/docs/assets/pearl_shuffle_019331_1_kdpmpp2m15_PS7.5_img2img-0.0_a_clown.jpg
diff --git a/docs/assets/pearl_shuffle_clown_019331_1_kdpmpp2m15_PS7.5_img2img-0.0_a_clown.jpg b/docs/assets/pearl_shuffle_clown_019331_1_kdpmpp2m15_PS7.5_img2img-0.0_a_clown.jpg
diff --git a/docs/assets/svd-rocket.gif b/docs/assets/svd-rocket.gif
diff --git a/docs/assets/wishbone_headshot_badscale.jpg b/docs/assets/wishbone_headshot_badscale.jpg
diff --git a/docs/assets/wishbone_headshot_details.jpg b/docs/assets/wishbone_headshot_details.jpg
diff --git a/docs/docs/CLI/colorize.md b/docs/docs/CLI/colorize.md
@@ -0,0 +1,3 @@
+::: mkdocs-click
+    :module: imaginairy.cli.colorize
+    :command: colorize_cmd
diff --git a/docs/docs/CLI/describe.md b/docs/docs/CLI/describe.md
@@ -0,0 +1,3 @@
+::: mkdocs-click
+    :module: imaginairy.cli.describe
+    :command: describe_cmd
diff --git a/docs/docs/CLI/edit.md b/docs/docs/CLI/edit.md
@@ -0,0 +1,3 @@
+::: mkdocs-click
+    :module: imaginairy.cli.edit
+    :command: edit_cmd
diff --git a/docs/docs/CLI/imagine.md b/docs/docs/CLI/imagine.md
@@ -0,0 +1,3 @@
+::: mkdocs-click
+    :module: imaginairy.cli.imagine
+    :command: imagine_cmd
diff --git a/docs/docs/CLI/upscale.md b/docs/docs/CLI/upscale.md
@@ -0,0 +1,3 @@
+::: mkdocs-click
+    :module: imaginairy.cli.upscale
+    :command: upscale_cmd
diff --git a/docs/docs/CLI/videogen.md b/docs/docs/CLI/videogen.md
@@ -0,0 +1,3 @@
+::: mkdocs-click
+    :module: imaginairy.cli.videogen
+    :command: videogen_cmd
diff --git a/docs/docs/Python/ControlInput.md b/docs/docs/Python/ControlInput.md
@@ -0,0 +1,2 @@
+
+::: imaginairy.schema.ControlInput
diff --git a/docs/docs/Python/ImaginePrompt.md b/docs/docs/Python/ImaginePrompt.md
@@ -0,0 +1,2 @@
+
+::: imaginairy.schema.ImaginePrompt
diff --git a/docs/docs/Python/LazyLoadingImage.md b/docs/docs/Python/LazyLoadingImage.md
@@ -0,0 +1,2 @@
+
+::: imaginairy.schema.LazyLoadingImage
diff --git a/docs/docs/Python/WeightedPrompt.md b/docs/docs/Python/WeightedPrompt.md
@@ -0,0 +1,2 @@
+
+::: imaginairy.schema.WeightedPrompt
diff --git a/docs/docs/Python/colorize-img.md b/docs/docs/Python/colorize-img.md
@@ -0,0 +1,2 @@
+
+::: imaginairy.api.colorize.colorize_img
diff --git a/docs/docs/Python/generate-video.md b/docs/docs/Python/generate-video.md
@@ -0,0 +1,2 @@
+
+::: imaginairy.api.video_sample.generate_video
diff --git a/docs/docs/Python/imagine-image-files.md b/docs/docs/Python/imagine-image-files.md
@@ -0,0 +1,3 @@
+
+
+::: imaginairy.api.generate.imagine_image_files
diff --git a/docs/docs/Python/imagine.md b/docs/docs/Python/imagine.md
@@ -0,0 +1,2 @@
+
+::: imaginairy.api.generate.imagine