Document the documentation process

PermafrostDiscoveryGateway · Jul 3, 2020 · f35146c · f35146c
1 parent e80a146
commit f35146c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -7,7 +7,7 @@
     - pip install .
     - pip install .[dev]
     - pytest
-    - flake8 setup.py py3dtiles/
+    - flake8 setup.py py3dtiles/ docs/
     # TODO move that in unit tests
     - py3dtiles info tests/pointCloudRGB.pnts
   tags:

diff --git a/docs/README.md b/docs/README.md
@@ -15,9 +15,15 @@ SPHINX_APIDOC_OPTIONS="members,show-inheritance" sphinx-apidoc -o ./api ../py3dt
 ```
 This command needs to be used only when new files are added (TODO check if sphinx-autoapi wouldn't do this job for us?)
 
-To regenerate the doc:
+To regenerate the doc for one version:
 
 ```
 make clean && make html
 ```
 (For some reason, make clean is often necessary if the toctree changes)
+
+To generate the doc as gitlab does it:
+
+```
+sphinx-multiversion . <outfolder>
+```
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,7 @@
 author = u'Augustin Trancart, Paul Blottière, Jérémy Gaillard, Ludovic Delauné, Nicolas Saul, Pierre-Éric Pelloux-Prayer, Raphaël Delhome, Vincent Jaillot, Éric Lemoine'
 
 # The short X.Y version
-latest_tag=subprocess.check_output(['git', 'describe', '--tags', '--abbrev=0'])
+latest_tag = subprocess.check_output(['git', 'describe', '--tags', '--abbrev=0'])
 print(latest_tag)
 version = latest_tag
 # The full version, including alpha/beta/rc tags