Merge branch '178-move-documentation-hosting-to-gitlab-page' into 'develop'

Resolve "Move documentation hosting to gitlab page"

See merge request slumber/multi-user!112

.gitlab-ci.yml

@@ -2,9 +2,12 @@ stages:
   - test
   - build
   - deploy
+  - doc
+
 
 
 include:
   - local: .gitlab/ci/test.gitlab-ci.yml
   - local: .gitlab/ci/build.gitlab-ci.yml
   - local: .gitlab/ci/deploy.gitlab-ci.yml
+  - local: .gitlab/ci/doc.gitlab-ci.yml

.gitlab/ci/build.gitlab-ci.yml

@@ -1,5 +1,6 @@
 build:
   stage: build
+  needs: ["test"]
   image: debian:stable-slim
   script:
     - rm -rf tests .git .gitignore script

.gitlab/ci/deploy.gitlab-ci.yml

@@ -1,5 +1,6 @@
 deploy:
   stage: deploy
+  needs: ["build"]
   image: slumber/docker-python  
   variables:
     DOCKER_DRIVER: overlay2

.gitlab/ci/doc.gitlab-ci.yml

@@ -0,0 +1,16 @@
+pages:
+  stage: doc
+  needs: ["deploy"]
+  image: python:3.7-alpine
+  script:
+  - pip install -U sphinx sphinx_rtd_theme
+  - sphinx-build -b html ./docs public
+  artifacts:
+    paths:
+    - public
+  only:
+    refs:
+    - master
+    - develop
+
+

README.md

@@ -19,31 +19,32 @@ This tool aims to allow multiple users to work on the same scene over the networ
 
 ## Usage
 
-See the [documentation](https://multi-user.readthedocs.io/en/latest/) for details.
+See the [documentation](https://slumber.gitlab.io/multi-user/index.html) for details.
 
 ## Troubleshooting
 
-See the [troubleshooting guide](https://multi-user.readthedocs.io/en/latest/getting_started/troubleshooting.html) for tips on the most common issues.
+See the [troubleshooting guide](https://slumber.gitlab.io/multi-user/getting_started/troubleshooting.html) for tips on the most common issues.
 
 ## Current development status
 
 Currently, not all data-block are supported for replication over the wire. The following list summarizes the status for each ones.
 
 | Name           | Status | Comment                                                                      |
-| ----------- | :----: | :--------------------------------------------------------------------------: |
+| -------------- | :----: | :--------------------------------------------------------------------------: |
 | action         | ✔️   |                                                                              |
 | armature       | ❗     | Not stable                                                                   |
 | camera         | ✔️   |                                                                              |
 | collection     | ✔️   |                                                                              |
-| curve       |   ❗    |                             Nurbs not supported                              |
+| curve          | ❗     | Nurbs surfaces not supported                                                 |
 | gpencil        | ✔️   | [Airbrush not supported](https://gitlab.com/slumber/multi-user/-/issues/123) |
 | image          | ✔️   |                                                                              |
 | mesh           | ✔️   |                                                                              |
 | material       | ✔️   |                                                                              |
 | node_groups    | ❗     | Material only                                                                |
+| geometry nodes | ✔️   |                                                                              |
 | metaball       | ✔️   |                                                                              |
 | object         | ✔️   |                                                                              |
-| textures    |   ❗    |                         Supported for modifiers only                         |
+| textures       | ❗     | Supported for modifiers/materials only                                       |
 | texts          | ✔️   |                                                                              |
 | scene          | ✔️   |                                                                              |
 | world          | ✔️   |                                                                              |
@@ -59,6 +60,7 @@ Currently, not all data-block are supported for replication over the wire. The f
 | libraries      | ❗     | Partial                                                                      |
 
 
+
 ### Performance issues
 
 Since this addon is written in pure python for a research purpose, performances could be better from all perspective.
@@ -74,7 +76,7 @@ I'm working on it.
 
 ## Contributing
 
-See [contributing section](https://multi-user.readthedocs.io/en/latest/ways_to_contribute.html) of the documentation.
+See [contributing section](https://slumber.gitlab.io/multi-user/ways_to_contribute.html) of the documentation.
 
 Feel free to [join the discord server](https://discord.gg/aBPvGws) to chat, seek help and contribute.