docs: fix latest tag

Skip copying the latest tag to latest if there is no latest tag. Enable html_image to use the HTML snippet from the README.
quarkslab · Jun 4, 2024 · 9bc35cc · 9bc35cc
1 parent 4908089
commit 9bc35cc
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 5 deletions.
diff --git a/Makefile b/Makefile
@@ -112,7 +112,7 @@ coverage: init
 coverage-ci: # Run coverage, generate JUnit test report and XML coverage report.
 coverage-ci: init-ci compile-primitives-ci
 	@echo "[+] Testing and checking coverage (CI)"
-	poetry run pytest --verbose --junitxml=junit/test-results.xml --cov="crypto_condor" --cov-report=xml --numprocesses=auto tests/
+	poetry run pytest --verbose --junitxml=junit/test-results.xml --cov="crypto_condor" --cov-report=xml --numprocesses=auto --dist worksteal tests/
 # Print coverage report so that CI picks up stats
 	poetry run coverage report
 
@@ -157,7 +157,7 @@ pages-ci: init-ci
 # Rename docs from main to devel.
 	mv docs/build/public/main docs/build/public/devel
 # Move latest tag to latest.
-	-LATEST_TAG="$(shell git describe --tags --abbrev=0 --exclude='*rc[0-9]')" && cp -R docs/build/public/$$LATEST_TAG docs/build/public/latest
+	-LATEST_TAG="$(shell git describe --tags --abbrev=0 --exclude='*rc[0-9]')"; [ -z "$$LATEST_TAG" ] && cp -R docs/build/public/$$LATEST_TAG docs/build/public/latest
 
 .PHONY: docs
 docs: # Build the documentation

diff --git a/README.md b/README.md
@@ -68,8 +68,8 @@ file.
 Once installed, the CLI is available as `crypto-condor-cli`. It is structured in
 commands, similar to Git. Run it without arguments or with `--help` to display
 the help message detailing the available subcommands. You can check [the
-documentation](https://quarkslab.github.io/crypto-condor) for a quick rundown of
-all the commands.
+documentation](https://quarkslab.github.io/crypto-condor/latest/index.html) for
+a quick rundown of all the commands.
 
 As for the Python library, it is available as `crypto_condor` (note the
 underscore). Each primitive has its own module under `primitives`, e.g.

diff --git a/docs/source/_static/redirect-index.html b/docs/source/_static/redirect-index.html
@@ -6,7 +6,7 @@
 </head>
 
 <body>
-    <p>Redirecting to the documentation...</p>
+    <p>Redirecting to the latest version...</p>
 </body>
 
 </html>

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -88,6 +88,7 @@
 myst_enable_extensions = [
     "colon_fence",
     "dollarmath",
+    "html_image",
     "substitution",
 ]
 myst_substitutions = {

diff --git a/docs/source/crypto-condor.png b/docs/source/crypto-condor.png
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 +6,7 @@ @@
     </head>
     <body>
-        <p>Redirecting to the documentation...</p>
+        <p>Redirecting to the latest version...</p>
     </body>
     </html>
@@ Expand Down @@