chore: Remove sphinx-multiversion

environments/review-docs-bump-gtj80d/deployments/17527
Georg krause 2023-04-05 20:53:10 +02:00
rodzic d075c6ae2b
commit fbaa6e7b71
6 zmienionych plików z 8 dodań i 38 usunięć

Wyświetl plik

@ -289,9 +289,9 @@ deploy_documentation:
- eval `ssh-agent -s` - eval `ssh-agent -s`
- echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add - - echo "$SSH_PRIVATE_KEY" | tr -d '\r' | ssh-add -
script: script:
- rsync -r -e "ssh -p 2282" $CI_PROJECT_DIR/public/ docs@docs.funkwhale.audio:/htdocs/ - rsync -r -e "ssh -p 2282" $CI_PROJECT_DIR/public/ docs@docs.funkwhale.audio:/htdocs/$CI_COMMIT_REF_NAME
only: rules:
- stable - if: $CI_COMMIT_BRANCH =~ /(stable|develop)/
.docker_publish: .docker_publish:

Wyświetl plik

@ -1,19 +1,13 @@
{%- if current_version %}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version"> <span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Other Versions</span> <span class="fa fa-book"> Other Versions</span>
{{ current_version.name }}
<span class="fa fa-caret-down"></span> <span class="fa fa-caret-down"></span>
</span> </span>
<div class="rst-other-versions"> <div class="rst-other-versions">
{%- if versions.branches %}
<dl> <dl>
<dt>Versions</dt> <dt>Versions</dt>
{%- for item in versions.branches %} <dd><a href="/">stable</a></dd>
<dd><a href="{{ item.url }}">{{ item.name }}</a></dd> <dd><a href="/develop">develop</a></dd>
{%- endfor %}
</dl> </dl>
{%- endif %}
</div> </div>
</div> </div>
{%- endif %}

Wyświetl plik

@ -1,6 +1,3 @@
#!/bin/bash -eux #!/bin/bash -eux
# Building sphinx and swagger docs # Building sphinx and swagger docs
poetry run sphinx-multiversion . $BUILD_PATH poetry run sphinx-build . $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

Wyświetl plik

@ -51,7 +51,6 @@ extensions = [
"sphinx.ext.autodoc", "sphinx.ext.autodoc",
"myst_parser", "myst_parser",
"sphinx_design", "sphinx_design",
"sphinx_multiversion",
] ]
autodoc_mock_imports = [ autodoc_mock_imports = [
"celery", "celery",
@ -248,7 +247,3 @@ def copy_legacy_redirects(app, docname):
def setup(app): def setup(app):
app.connect("build-finished", copy_legacy_redirects) app.connect("build-finished", copy_legacy_redirects)
smv_tag_whitelist = None
smv_branch_whitelist = r"(stable|develop)$"

19
docs/poetry.lock wygenerowano
Wyświetl plik

@ -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]] [[package]]
name = "alabaster" 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-rtd = ["sphinx-rtd-theme (>=1.0,<2.0)"]
theme-sbt = ["sphinx-book-theme (>=0.3.0,<0.4.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]] [[package]]
name = "sphinx-rtd-theme" name = "sphinx-rtd-theme"
version = "1.0.0" version = "1.0.0"
@ -739,4 +724,4 @@ socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"]
[metadata] [metadata]
lock-version = "2.0" lock-version = "2.0"
python-versions = "^3.10" python-versions = "^3.10"
content-hash = "57d4d1b88dbc0977b58aa9e31cfaeeb5e85157856e1537782f22fea270fcac05" content-hash = "ced67696052d9d7be854108367215f9b6f68213797c8253bb0cdaeea4f22f0f8"

Wyświetl plik

@ -12,7 +12,6 @@ sphinx-rtd-theme = "1.0.0"
django-environ = "0.8.1" django-environ = "0.8.1"
Django = "==4.0.6" Django = "==4.0.6"
myst-parser = "==0.17.2" myst-parser = "==0.17.2"
sphinx-multiversion = "0.2.4"
sphinx_design = "0.2.0" sphinx_design = "0.2.0"
[tool.poetry.dev-dependencies] [tool.poetry.dev-dependencies]