feat(docs): set up docs site (#436)

ssube · Dec 16, 2023 · 523a2a0 · 523a2a0
1 parent b3cf0ac
commit 523a2a0
Show file tree

Hide file tree

Showing 6 changed files with 263 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-convert_stable_diffusion_checkpoint_to_onnx.py
+convert_stable_diffusion_checkpoint_to_onnx.py
+site/
diff --git a/docs/api.md b/docs/api.md
@@ -1,8 +1,8 @@
-# ONNX Web API
+# API
 
 ## Contents
 
-- [ONNX Web API](#onnx-web-api)
+- [API](#api)
   - [Contents](#contents)
   - [Endpoints](#endpoints)
     - [GUI bundle](#gui-bundle)

diff --git a/docs/architecture.md b/docs/architecture.md
@@ -1,4 +1,4 @@
-# onnx-web Architecture
+# Architecture
 
 ## Contents
 

diff --git a/docs/getting-started.md b/docs/getting-started.md
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,17 @@
+# onnx-web
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,12 @@
+repo_url: https://github.com/ssube/onnx-web
+site_name: onnx-web docs
+site_url: https://onnx-web.ai/docs
+exclude_docs: |
+  runpod-readme.md
+markdown_extensions:
+  - mdx_truly_sane_lists
+plugins:
+  - search:
+      prebuild_index: true
+theme:
+  name: readthedocs