Merge pull request #36 from iqm-finland/COMP-404-EXTERNAL-TOKENS-AUTH

Fix documentation

CHANGELOG.rst

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+Version 4.2
+===========
+
+* Update documentation to include development version and certain released versions in a subdirectory. `#36 <https://github.com/iqm-finland/iqm-client/pull/36>`_
+
 Version 4.1
 ===========
 

docs/conf.py

@@ -190,8 +190,9 @@
 # -- Options for sphinx_multiversion --------------------------------------------------
 # Only include certain tags (i.e. all tags except for ones listed below)
 # (technically a whitelist, but we treat it as blacklist by using negative lookahead regex `?!`)
-smv_tag_whitelist = r'^(?!(1\.0|1\.1\b|1\.2|1\.3|1\.4|1\.5|1\.6|1\.7|1\.8|1\.9|2\.0|2\.1)).*$' 
+smv_tag_whitelist = r'^(?!(1\.0|1\.1\b|1\.2|1\.3|1\.4|1\.5|1\.6|1\.7|1\.8|1\.9|2\.0|2\.1|4\.1)).*$'
 
 smv_branch_whitelist = "None"   # Do not include local branches in versions list
 smv_remote_whitelist = "None"   # Do not include remote branches in versions list
 smv_released_pattern = r'^refs/tags/.*$'  # Tags recognized as releases
+smv_outputdir_format = 'versions/{ref.name}'  # Store versioned docs in a subdirectory

setup.cfg

@@ -54,7 +54,7 @@ dev =
     tox == 3.25.0
 docs =
     sphinx == 4.5.0
-    sphinx-multiversion-contrib == 0.2.6
+    sphinx-multiversion-contrib == 0.2.8
     sphinx-book-theme == 0.3.2
 testing =
     isort == 5.10.1

src/iqm_client/iqm_client.py

@@ -311,7 +311,7 @@ class ExternalToken(BaseModel):
     """Externally managed token for maintaining a session with the authentication server.
 
     * Fields ``auth_server_url`` and ``access_token`` are loaded from an
-    external resource, e.g. file generated by Cortex CLI's token manager.
+      external resource, e.g. file generated by Cortex CLI's token manager.
     """
 
     auth_server_url: str = Field(..., description='Base URL of the authentication server')

tox.ini

@@ -22,22 +22,19 @@ commands =
 
 [testenv:docs]
 description =
-    Invoke sphinx-build to build the docs.
+    Invoke sphinx-multiversion to build the docs.
 setenv =
     DOCSDIR = {toxinidir}/docs
     BUILDDIR = {toxinidir}/build/sphinx
     BUILD = html
 extras =
     docs
-allowlist_externals = 
+allowlist_externals =
     cp
-    sphinx-build
     sphinx-multiversion
 commands =
     python {toxinidir}/docs/generate_json_schemas.py
-    sphinx-multiversion "{env:DOCSDIR}" "{env:BUILDDIR}/{env:BUILD}" -W
-    cp {toxinidir}/docs/_static/index.html "{env:BUILDDIR}/{env:BUILD}"
-
+    sphinx-multiversion "{env:DOCSDIR}" "{env:BUILDDIR}/{env:BUILD}" -W --dev-name dev
 
 [testenv:build]
 description =