Merge pull request #12 from LuxDL/ap/docs

Transition to the new documentation system
LuxDL · Aug 26, 2023 · d3ea9e2 · d3ea9e2 · avik-pal · Aug 26, 2023
2 parents 07dc08a + 1b3b21e
commit d3ea9e2
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 397 deletions.
diff --git a/.github/workflows/DocCleanUp.yml b/.github/workflows/DocCleanUp.yml
diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "LuxDeviceUtils"
 uuid = "34f89e08-e1d5-43b4-8944-0b49ac560553"
 authors = ["Avik Pal <[email protected]> and contributors"]
-version = "0.1.6"
+version = "0.1.7"
 
 [deps]
 Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"

diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # LuxDeviceUtils
 
 [![Join the chat at https://julialang.zulipchat.com #machine-learning](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/machine-learning)
-[![Latest Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://luxdl.github.io/LuxDeviceUtils.jl/dev)
-[![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://luxdl.github.io/LuxDeviceUtils.jl/stable)
+[![Latest Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://lux.csail.mit.edu/dev/api/)
+[![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://lux.csail.mit.edu/stable/api/)
 
 [![CI](https://github.com/LuxDL/LuxDeviceUtils.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/LuxDL/LuxDeviceUtils.jl/actions/workflows/CI.yml)
 [![Buildkite](https://badge.buildkite.com/b098d6387b2c69bd0ab684293ff66332047b219e1b8f9bb486.svg?branch=main)](https://buildkite.com/julialang/luxdeviceutils-dot-jl)
@@ -13,4 +13,5 @@
 [![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
 [![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
 
-`LuxDeviceUtils.jl` is a lightweight package defining rules for transferring data across devices. Most users should directly use [Lux.jl](https://lux.csail.mit.edu/stable) instead.
+`LuxDeviceUtils.jl` is a lightweight package defining rules for transferring data across
+devices. Most users should directly use [Lux.jl](https://lux.csail.mit.edu/) instead.
diff --git a/docs/Project.toml b/docs/Project.toml
diff --git a/docs/_overrides/partials/source.html b/docs/_overrides/partials/source.html
diff --git a/docs/make.jl b/docs/make.jl
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
diff --git a/docs/src/assets/custom.css b/docs/src/assets/custom.css