[Feature] Publish docs

.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+   configuration: docs/source/conf.py
+
+formats:
+   - epub
+
+python:
+   install:
+     - requirements: requirements/docs.txt

README.md

@@ -1,9 +1,11 @@
 # DiffEngine
 
 [![build](https://github.com/okotaku/diffengine/actions/workflows/build.yml/badge.svg)](https://github.com/okotaku/diffengine/actions/workflows/build.yml)
+[![Docs](https://img.shields.io/badge/docs-latest-blue)](https://diffengine.readthedocs.io/en/latest/)
 [![license](https://img.shields.io/github/license/okotaku/diffengine.svg)](https://github.com/okotaku/diffengine/blob/main/LICENSE)
 [![open issues](https://isitmaintained.com/badge/open/okotaku/diffengine.svg)](https://github.com/okotaku/diffengine/issues)
 
+[📘 Documentation](https://diffengine.readthedocs.io/en/latest/) |
 [🤔 Reporting Issues](https://github.com/okotaku/diffengine/issues/new/choose)
 
 ## 📄 Table of Contents
@@ -97,30 +99,30 @@ For a more hands-on introduction to DiffEngine, you can refer to the [Example No
 
 ## 📘 Documentation [🔝](#-table-of-contents)
 
-For detailed user guides and advanced guides, please refer to our [Documentation](docs/source/):
+For detailed user guides and advanced guides, please refer to our [Documentation](https://diffengine.readthedocs.io/en/latest/):
 
-- [Get Started](docs/source/get_started.md) for get started.
+- [Get Started](https://diffengine.readthedocs.io/en/latest/get_started.html) for get started.
 
 <details>
 <summary>Run Guides</summary>
 
-- [Run Stable Diffusion](docs/source/run_guides/run_sd.md)
-- [Run Stable Diffusion XL](docs/source/run_guides/run_sdxl.md)
-- [Run Stable Diffusion DreamBooth](docs/source/run_guides/run_dreambooth.md)
-- [Run Stable Diffusion XL DreamBooth](docs/source/run_guides/run_dreambooth_xl.md)
-- [Run Stable Diffusion LoRA](docs/source/run_guides/run_lora.md)
-- [Run Stable Diffusion XL LoRA](docs/source/run_guides/run_lora_xl.md)
-- [Run Stable Diffusion ControlNet](docs/source/run_guides/run_controlnet.md)
-- [Run Stable Diffusion XL ControlNet](docs/source/run_guides/run_controlnet_xl.md)
-- [Inference](docs/source/run_guides/inference.md)
+- [Run Stable Diffusion](https://diffengine.readthedocs.io/en/latest/run_guides/run_sd.html)
+- [Run Stable Diffusion XL](https://diffengine.readthedocs.io/en/latest/run_guides/run_sdxl.html)
+- [Run Stable Diffusion DreamBooth](https://diffengine.readthedocs.io/en/latest/run_guides/run_dreambooth.html)
+- [Run Stable Diffusion XL DreamBooth](https://diffengine.readthedocs.io/en/latest/run_guides/run_dreambooth_xl.html)
+- [Run Stable Diffusion LoRA](https://diffengine.readthedocs.io/en/latest/run_guides/run_lora.html)
+- [Run Stable Diffusion XL LoRA](https://diffengine.readthedocs.io/en/latest/run_guides/run_lora_xl.html)
+- [Run Stable Diffusion ControlNet](https://diffengine.readthedocs.io/en/latest/run_guides/run_controlnet.html)
+- [Run Stable Diffusion XL ControlNet](https://diffengine.readthedocs.io/en/latest/run_guides/run_controlnet_xl.html)
+- [Inference](https://diffengine.readthedocs.io/en/latest/run_guides/inference.html)
 
 </details>
 
 <details>
 <summary>User Guides</summary>
 
-- [Learn About Config](docs/source/user_guides/config.md)
-- [Prepare Dataset](docs/source/user_guides/dataset_prepare.md)
+- [Learn About Config](https://diffengine.readthedocs.io/en/latest/user_guides/config.html)
+- [Prepare Dataset](https://diffengine.readthedocs.io/en/latest/user_guides/dataset_prepare.html)
 
 </details>
 

docs/source/conf.py

@@ -35,13 +35,32 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx_autodoc_typehints',
-    'sphinx.ext.viewcode'
-]
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'myst_parser',
+    'sphinx_copybutton',
+    'sphinx.ext.autodoc.typehints',
+    'sphinx_tabs.tabs',
+]  # yapf: disable
+
+autodoc_typehints = 'description'
+myst_heading_anchors = 4
+myst_enable_extensions = ['colon_fence']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #

requirements/docs.txt

@@ -0,0 +1,12 @@
+docutils==0.18.1
+modelindex
+myst-parser
+git+https://github.com/mzr1996/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
+sphinx==6.1.3
+sphinx-autodoc-typehints
+sphinx-copybutton
+sphinx-notfound-page
+sphinx-rtd-theme
+sphinx-tabs
+sphinxcontrib-jquery
+tabulate