diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 8b1a2cc12..0125dd70e 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -289,9 +289,9 @@ deploy_documentation: - eval `ssh-agent -s` - echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add - script: - - rsync -r -e "ssh -p 2282" $CI_PROJECT_DIR/public/ docs@docs.funkwhale.audio:/htdocs/ - only: - - stable + - rsync -r -e "ssh -p 2282" $CI_PROJECT_DIR/public/ docs@docs.funkwhale.audio:/htdocs/$CI_COMMIT_REF_NAME + rules: + - if: $CI_COMMIT_BRANCH =~ /(stable|develop)/ .docker_publish: diff --git a/docs/_templates/versions.html b/docs/_templates/versions.html index 5f38020b9..d1a0885fc 100644 --- a/docs/_templates/versions.html +++ b/docs/_templates/versions.html @@ -1,19 +1,13 @@ -{%- if current_version %}
Other Versions - {{ current_version.name }}
- {%- if versions.branches %}
Versions
- {%- for item in versions.branches %} -
{{ item.name }}
- {%- endfor %} +
stable
+
develop
- {%- endif %}
-{%- endif %} diff --git a/docs/build_docs.sh b/docs/build_docs.sh index 4fb40928f..c1323afe8 100755 --- a/docs/build_docs.sh +++ b/docs/build_docs.sh @@ -1,6 +1,3 @@ #!/bin/bash -eux # Building sphinx and swagger docs -poetry run sphinx-multiversion . $BUILD_PATH -TARGET_PATH="$BUILD_PATH/swagger" ./build_swagger.sh -python ./get-releases-json.py > $BUILD_PATH/releases.json -python ./get-releases-json.py --latest > $BUILD_PATH/latest.txt +poetry run sphinx-build . $BUILD_PATH diff --git a/docs/conf.py b/docs/conf.py index 11c0b2310..8622c7635 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,7 +51,6 @@ extensions = [ "sphinx.ext.autodoc", "myst_parser", "sphinx_design", - "sphinx_multiversion", ] autodoc_mock_imports = [ "celery", @@ -248,7 +247,3 @@ def copy_legacy_redirects(app, docname): def setup(app): app.connect("build-finished", copy_legacy_redirects) - - -smv_tag_whitelist = None -smv_branch_whitelist = r"(stable|develop)$" diff --git a/docs/poetry.lock b/docs/poetry.lock index a2f5771ee..597f5df9d 100644 --- a/docs/poetry.lock +++ b/docs/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.4.0 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.4.1 and should not be changed by hand. [[package]] name = "alabaster" @@ -554,21 +554,6 @@ theme-pydata = ["pydata-sphinx-theme (>=0.9.0,<0.10.0)"] theme-rtd = ["sphinx-rtd-theme (>=1.0,<2.0)"] theme-sbt = ["sphinx-book-theme (>=0.3.0,<0.4.0)"] -[[package]] -name = "sphinx-multiversion" -version = "0.2.4" -description = "Add support for multiple versions to sphinx" -category = "main" -optional = false -python-versions = "*" -files = [ - {file = "sphinx-multiversion-0.2.4.tar.gz", hash = "sha256:5cd1ca9ecb5eed63cb8d6ce5e9c438ca13af4fa98e7eb6f376be541dd4990bcb"}, - {file = "sphinx_multiversion-0.2.4-py3-none-any.whl", hash = "sha256:dec29f2a5890ad68157a790112edc0eb63140e70f9df0a363743c6258fbeb478"}, -] - -[package.dependencies] -sphinx = ">=2.1" - [[package]] name = "sphinx-rtd-theme" version = "1.0.0" @@ -739,4 +724,4 @@ socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"] [metadata] lock-version = "2.0" python-versions = "^3.10" -content-hash = "57d4d1b88dbc0977b58aa9e31cfaeeb5e85157856e1537782f22fea270fcac05" +content-hash = "ced67696052d9d7be854108367215f9b6f68213797c8253bb0cdaeea4f22f0f8" diff --git a/docs/pyproject.toml b/docs/pyproject.toml index 51e9e68fb..c9723b129 100644 --- a/docs/pyproject.toml +++ b/docs/pyproject.toml @@ -12,7 +12,6 @@ sphinx-rtd-theme = "1.0.0" django-environ = "0.8.1" Django = "==4.0.6" myst-parser = "==0.17.2" -sphinx-multiversion = "0.2.4" sphinx_design = "0.2.0" [tool.poetry.dev-dependencies]