From f2dc35a9c5b70fb9376a44d86f2e69d1a60f7ac5 Mon Sep 17 00:00:00 2001 From: DMITRIY PEDCHENKO Date: Thu, 28 Mar 2024 12:52:00 +0300 Subject: [PATCH 1/9] [DOP-11710] Translate documentation to ReadTheDocs --- docs/_static/custom.css | 3 +++ docs/_static/openapi.json | 9 +++++++++ docs/_static/redoc.html | 28 ++++++++++++++++++++++++++++ docs/_static/swagger.html | 26 ++++++++++++++++++++++++++ 4 files changed, 66 insertions(+) create mode 100644 docs/_static/custom.css create mode 100644 docs/_static/openapi.json create mode 100644 docs/_static/redoc.html create mode 100644 docs/_static/swagger.html diff --git a/docs/_static/custom.css b/docs/_static/custom.css new file mode 100644 index 00000000..ac17ca7e --- /dev/null +++ b/docs/_static/custom.css @@ -0,0 +1,3 @@ +.logo { + width: 200px !important; +} diff --git a/docs/_static/openapi.json b/docs/_static/openapi.json new file mode 100644 index 00000000..7b3bf552 --- /dev/null +++ b/docs/_static/openapi.json @@ -0,0 +1,9 @@ +{ + "openapi": "3.1.0", + "version": "unknown", + "info": { + "title": "Generated in CI", + "version": "unknown" + }, + "paths": {} +} \ No newline at end of file diff --git a/docs/_static/redoc.html b/docs/_static/redoc.html new file mode 100644 index 00000000..3c4246e5 --- /dev/null +++ b/docs/_static/redoc.html @@ -0,0 +1,28 @@ + + + + + Horizon - ReDoc + + + + + + + + + + + + + + diff --git a/docs/_static/swagger.html b/docs/_static/swagger.html new file mode 100644 index 00000000..0f891cd9 --- /dev/null +++ b/docs/_static/swagger.html @@ -0,0 +1,26 @@ + + + + + + + SwaggerUI + + + + +
+ + + + From 91df58002db2f22b8331269b3ef892359d04ccbb Mon Sep 17 00:00:00 2001 From: DMITRIY PEDCHENKO Date: Thu, 28 Mar 2024 12:53:06 +0300 Subject: [PATCH 2/9] [DOP-11710] Translate documentation to ReadTheDocs --- docs/_static/redoc.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_static/redoc.html b/docs/_static/redoc.html index 3c4246e5..0863f2c1 100644 --- a/docs/_static/redoc.html +++ b/docs/_static/redoc.html @@ -2,7 +2,7 @@ - Horizon - ReDoc + SyncMaster - ReDoc From 2bef81f42cb863993114e22d93138bf351d88778 Mon Sep 17 00:00:00 2001 From: DMITRIY PEDCHENKO Date: Thu, 28 Mar 2024 13:10:02 +0300 Subject: [PATCH 3/9] [DOP-11710] Translate documentation to ReadTheDocs --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2941eceb..1eca671b 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,7 @@ build: post_create_environment: - python -m pip install poetry - python -m pip install sphinx-plantuml # remove after https://github.com/zqmillet/sphinx-plantuml/pull/4 + - python -m pip install sphinxarg - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry config virtualenvs.create false - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry config virtualenvs.prefer-active-python true - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry debug info From 3d6a09d7f7125519e609e3563ae0eb6646eaf8e6 Mon Sep 17 00:00:00 2001 From: DMITRIY PEDCHENKO Date: Thu, 28 Mar 2024 13:18:01 +0300 Subject: [PATCH 4/9] [DOP-11710] Translate documentation to ReadTheDocs --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1eca671b..e0292c29 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,7 +8,7 @@ build: post_create_environment: - python -m pip install poetry - python -m pip install sphinx-plantuml # remove after https://github.com/zqmillet/sphinx-plantuml/pull/4 - - python -m pip install sphinxarg + - python -m pip install sphinx-argparse - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry config virtualenvs.create false - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry config virtualenvs.prefer-active-python true - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry debug info From 0c3d9d20a47e63601869b95743a1c88adf1c43f5 Mon Sep 17 00:00:00 2001 From: DMITRIY PEDCHENKO Date: Thu, 28 Mar 2024 13:24:48 +0300 Subject: [PATCH 5/9] [DOP-11710] Translate documentation to ReadTheDocs --- .readthedocs.yaml | 1 - poetry.lock | 19 ++++++++++++++++++- pyproject.toml | 1 + 3 files changed, 19 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e0292c29..2941eceb 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,7 +8,6 @@ build: post_create_environment: - python -m pip install poetry - python -m pip install sphinx-plantuml # remove after https://github.com/zqmillet/sphinx-plantuml/pull/4 - - python -m pip install sphinx-argparse - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry config virtualenvs.create false - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry config virtualenvs.prefer-active-python true - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH python -m poetry debug info diff --git a/poetry.lock b/poetry.lock index 02b6c83b..c67feff6 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2513,6 +2513,23 @@ docs = ["sphinxcontrib-websupport"] lint = ["docutils-stubs", "flake8 (>=3.5.0)", "flake8-simplify", "isort", "mypy (>=0.990)", "ruff", "sphinx-lint", "types-requests"] test = ["cython (>=3.0)", "filelock", "html5lib", "pytest (>=4.6)", "setuptools (>=67.0)"] +[[package]] +name = "sphinx-argparse" +version = "0.2.5" +description = "A sphinx extension that automatically documents argparse commands and options" +optional = false +python-versions = "*" +files = [ + {file = "sphinx-argparse-0.2.5.tar.gz", hash = "sha256:60ab98f80ffd38731d62e267171388a421abbc96c74901b7785a8e058b438c17"}, +] + +[package.dependencies] +sphinx = ">=1.2.0" + +[package.extras] +dev = ["pytest", "sphinx_rtd_theme"] +markdown = ["CommonMark (>=0.5.6)"] + [[package]] name = "sphinx-basic-ng" version = "1.0.0b2" @@ -3125,4 +3142,4 @@ worker = ["onetl", "psycopg2-binary"] [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "5eeea2374665d56e7cbbc95d8fd9b087653c535929b780bebe18bd03e1908ed4" +content-hash = "70fedb86632d682d49730c0f698614e28b3573de197c667db0b521e5cffac4c6" diff --git a/pyproject.toml b/pyproject.toml index 3375249c..0eed1aea 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -210,6 +210,7 @@ towncrier = {version = "^23.11.0", python = ">=3.8"} sphinx-issues = {version = ">=3.0.1,<5.0.0", python = ">=3.8"} sphinx-design = {version = "^0.5.0", python = ">=3.8"} sphinx-favicon = {version = "^1.0.1", python = ">=3.8"} +sphinx-argparse = {version = "^0.2.5", python = ">=3.8"} # uncomment after https://github.com/zqmillet/sphinx-plantuml/pull/4 # sphinx-plantuml = {version = "^1.0.0", python = ">=3.8"} From 1a0d5b6bbbc396a73e5c6bae786da4e0127f0334 Mon Sep 17 00:00:00 2001 From: DMITRIY PEDCHENKO Date: Thu, 28 Mar 2024 14:13:52 +0300 Subject: [PATCH 6/9] [DOP-11710] Translate documentation to ReadTheDocs --- docs/index.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 26d473a8..ce9b052e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,5 @@ .. include:: ../README.rst -.. include:: ../README.rst - .. toctree:: :maxdepth: 2 :caption: High-level design From d55bc35259cc3b38ec498115e69d4d44f2761b4f Mon Sep 17 00:00:00 2001 From: DMITRIY PEDCHENKO Date: Thu, 28 Mar 2024 14:18:05 +0300 Subject: [PATCH 7/9] [DOP-11710] Translate documentation to ReadTheDocs --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 3a91640b..1c861b7c 100644 --- a/README.rst +++ b/README.rst @@ -18,7 +18,7 @@ SyncMaster .. |Docker image| image:: https://img.shields.io/docker/v/mtsrus/syncmaster-backend?sort=semver&label=docker :target: https://hub.docker.com/r/mtsrus/syncmaster-backend .. |Documentation| image:: https://readthedocs.org/projects/data-syncmaster/badge/?version=stable - :target: https://data-syncmaster.readthedocs.io/ + :target: https://syncmaster.readthedocs.io/en/latest/ .. |Build Status| image:: https://github.com/MobileTeleSystems/syncmaster/workflows/Tests/badge.svg :target: https://github.com/MobileTeleSystems/syncmaster/actions .. |Coverage| image:: https://codecov.io/gh/MobileTeleSystems/syncmaster/graph/badge.svg?token=ky7UyUxolB From 3e041075f52db0adacac22764b524f9a124a5b30 Mon Sep 17 00:00:00 2001 From: DMITRIY PEDCHENKO Date: Thu, 28 Mar 2024 14:24:46 +0300 Subject: [PATCH 8/9] [DOP-11710] Translate documentation to ReadTheDocs --- README.rst | 2 +- docs/design/permissions.rst | 4 ++-- pyproject.toml | 1 + 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 1c861b7c..79fb77b4 100644 --- a/README.rst +++ b/README.rst @@ -63,4 +63,4 @@ Non-goals Documentation ------------- -See https://data-syncmaster.readthedocs.io/ \ No newline at end of file +See https://syncmaster.readthedocs.io/en/latest/ \ No newline at end of file diff --git a/docs/design/permissions.rst b/docs/design/permissions.rst index add09eb5..b913a5bf 100644 --- a/docs/design/permissions.rst +++ b/docs/design/permissions.rst @@ -1,7 +1,7 @@ .. _role-permissions: -Roles and rules -=============== +Roles and permissions +===================== - Object within the group can be seen/interacted with only by users which are members of the group. - Permissions are limited by role assigned to user within specific group. diff --git a/pyproject.toml b/pyproject.toml index 0eed1aea..f2549566 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,6 +36,7 @@ exclude = [ [tool.poetry.urls] # Optional "Homepage" = "https://github.com/MobileTeleSystems/syncmaster" +"Documentation" = "https://syncmaster.readthedocs.io/en/latest/" "Source" = "https://github.com/MobileTeleSystems/syncmaster" "CI/CD" = "https://github.com/MobileTeleSystems/syncmaster/actions" "Tracker" = "https://github.com/MobileTeleSystems/syncmaster/issues" From 784a7d06a4202d42fdf38d4a5b51502a5e0f8c4c Mon Sep 17 00:00:00 2001 From: DMITRIY PEDCHENKO Date: Thu, 28 Mar 2024 14:28:00 +0300 Subject: [PATCH 9/9] [DOP-11710] Translate documentation to ReadTheDocs --- README.rst | 4 ++-- pyproject.toml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 79fb77b4..2bf89944 100644 --- a/README.rst +++ b/README.rst @@ -18,7 +18,7 @@ SyncMaster .. |Docker image| image:: https://img.shields.io/docker/v/mtsrus/syncmaster-backend?sort=semver&label=docker :target: https://hub.docker.com/r/mtsrus/syncmaster-backend .. |Documentation| image:: https://readthedocs.org/projects/data-syncmaster/badge/?version=stable - :target: https://syncmaster.readthedocs.io/en/latest/ + :target: https://syncmaster.readthedocs.io .. |Build Status| image:: https://github.com/MobileTeleSystems/syncmaster/workflows/Tests/badge.svg :target: https://github.com/MobileTeleSystems/syncmaster/actions .. |Coverage| image:: https://codecov.io/gh/MobileTeleSystems/syncmaster/graph/badge.svg?token=ky7UyUxolB @@ -63,4 +63,4 @@ Non-goals Documentation ------------- -See https://syncmaster.readthedocs.io/en/latest/ \ No newline at end of file +See https://syncmaster.readthedocs.io \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index f2549566..8433b926 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,7 +36,7 @@ exclude = [ [tool.poetry.urls] # Optional "Homepage" = "https://github.com/MobileTeleSystems/syncmaster" -"Documentation" = "https://syncmaster.readthedocs.io/en/latest/" +"Documentation" = "https://syncmaster.readthedocs.io" "Source" = "https://github.com/MobileTeleSystems/syncmaster" "CI/CD" = "https://github.com/MobileTeleSystems/syncmaster/actions" "Tracker" = "https://github.com/MobileTeleSystems/syncmaster/issues"