Redirect docs to website

VirtualPlantLab · Nov 9, 2023 · fba09b4 · fba09b4
1 parent 72f218c
commit fba09b4
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 40 deletions.
diff --git a/.github/workflows/Docs.yml b/.github/workflows/Docs.yml
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # SkyDomes
 
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://VirtualPlantLab.github.io/SkyDomes.jl/stable/)
-[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://VirtualPlantLab.github.io/SkyDomes.jl/dev/)
+[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://virtualplantlab.com/stable/SkyDomes/API/)
+[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://virtualplantlab.com/dev/SkyDomes/API/)
 [![CI](https://github.com/VirtualPlantLab/SkyDomes.jl/actions/workflows/CI.yml/badge.svg)](https://github.com/VirtualPlantLab/SkyDomes.jl/actions/workflows/CI.yml)
 [![Coverage](https://codecov.io/gh/VirtualPlantLab/SkyDomes.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/VirtualPlantLab/SkyDomes.jl)
 [![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,18 +1,32 @@
 
-# Module SkyDomes
+# SkyDomes.jl
 
 ```@meta
 CurrentModule = SkyDomes
 ```
 
-```@docs
-UniformSky
-StandardSky
-CIE
-radiosity
-equal_solid_angles
-equal_angle_intervals
-sky
-clear_sky
-waveband_conversion
+## Index
+
+```@index
+Modules = [SkyDomes]
+Public = true
+Private = true
+```
+
+## API documentation
+
+```@autodocs
+Modules = [SkyDomes]
+Public = true
+Private = false
+```
+
+## Un-exported
+
+Private functions, types or constants from `SkyDomes`. These are not exported, so you need to prefix the function name with `SkyDomes.` to access them:
+
+```@autodocs
+Modules = [SkyDomes]
+Public = false
+Private = true
 ```