From c9ed76fe44681a529d2e4ba9cca76e321e9679e1 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Ale=C5=A1?= Date: Wed, 26 May 2021 11:35:20 +0200 Subject: [PATCH] docs: fixdeps: sphinx-rtd-theme removed - not needed for development purposes --- manager/docs/conf.py | 10 +++++----- manager/poetry.lock | 27 ++++----------------------- manager/pyproject.toml | 3 +-- manager/scripts/docs | 8 ++++++++ 4 files changed, 18 insertions(+), 30 deletions(-) create mode 100755 manager/scripts/docs diff --git a/manager/docs/conf.py b/manager/docs/conf.py index 94c31b8d9..193d8dd65 100644 --- a/manager/docs/conf.py +++ b/manager/docs/conf.py @@ -14,7 +14,7 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) -import sphinx_rtd_theme +# import sphinx_rtd_theme # -- Project information ----------------------------------------------------- @@ -28,9 +28,9 @@ author = 'Aleš Mrázek' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [ - 'sphinx_rtd_theme' -] +# extensions = [ +# 'sphinx_rtd_theme', +# ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -46,7 +46,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +# html_theme = 'sphinx_rtd_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/manager/poetry.lock b/manager/poetry.lock index 0e3af7fc4..79c9b3d76 100644 --- a/manager/poetry.lock +++ b/manager/poetry.lock @@ -272,7 +272,7 @@ python-versions = "*" [[package]] name = "docutils" -version = "0.16" +version = "0.17.1" description = "Docutils -- Python Documentation Utilities" category = "dev" optional = false @@ -994,21 +994,6 @@ docs = ["sphinxcontrib-websupport"] lint = ["flake8 (>=3.5.0)", "isort", "mypy (>=0.800)", "docutils-stubs"] test = ["pytest", "pytest-cov", "html5lib", "cython", "typed-ast"] -[[package]] -name = "sphinx-rtd-theme" -version = "0.5.2" -description = "Read the Docs theme for Sphinx" -category = "dev" -optional = false -python-versions = "*" - -[package.dependencies] -docutils = "<0.17" -sphinx = "*" - -[package.extras] -dev = ["transifex-client", "sphinxcontrib-httpdomain", "bump2version"] - [[package]] name = "sphinxcontrib-applehelp" version = "1.0.2" @@ -1255,7 +1240,7 @@ testing = ["pytest (>=4.6)", "pytest-checkdocs (>=1.2.3)", "pytest-flake8", "pyt [metadata] lock-version = "1.1" python-versions = "^3.6.12" -content-hash = "eb46de32c7f8c8d9b1f4e52795830d5297cc665bd36873aa0db7d2005cf256f2" +content-hash = "ab70f3d6702baa7a8567eea9d58e0b5c9650e5c6b1c786309604dbabe8d44af6" [metadata.files] aiohttp = [ @@ -1489,8 +1474,8 @@ docopt = [ {file = "docopt-0.6.2.tar.gz", hash = "sha256:49b3a825280bd66b3aa83585ef59c4a8c82f2c8a522dbe754a8bc8d08c85c491"}, ] docutils = [ - {file = "docutils-0.16-py2.py3-none-any.whl", hash = "sha256:0c5b78adfbf7762415433f5515cd5c9e762339e23369dbe8000d84a4bf4ab3af"}, - {file = "docutils-0.16.tar.gz", hash = "sha256:c2de3a60e9e7d07be26b7f2b00ca0309c207e06c100f9cc2a94931fc75a478fc"}, + {file = "docutils-0.17.1-py2.py3-none-any.whl", hash = "sha256:cf316c8370a737a022b72b56874f6602acf974a37a9fba42ec2876387549fc61"}, + {file = "docutils-0.17.1.tar.gz", hash = "sha256:686577d2e4c32380bb50cbb22f575ed742d58168cee37e99117a854bcd88f125"}, ] dodgy = [ {file = "dodgy-0.2.1-py3-none-any.whl", hash = "sha256:51f54c0fd886fa3854387f354b19f429d38c04f984f38bc572558b703c0542a6"}, @@ -1957,10 +1942,6 @@ sphinx = [ {file = "Sphinx-4.0.2-py3-none-any.whl", hash = "sha256:d1cb10bee9c4231f1700ec2e24a91be3f3a3aba066ea4ca9f3bbe47e59d5a1d4"}, {file = "Sphinx-4.0.2.tar.gz", hash = "sha256:b5c2ae4120bf00c799ba9b3699bc895816d272d120080fbc967292f29b52b48c"}, ] -sphinx-rtd-theme = [ - {file = "sphinx_rtd_theme-0.5.2-py2.py3-none-any.whl", hash = "sha256:4a05bdbe8b1446d77a01e20a23ebc6777c74f43237035e76be89699308987d6f"}, - {file = "sphinx_rtd_theme-0.5.2.tar.gz", hash = "sha256:32bd3b5d13dc8186d7a42fc816a23d32e83a4827d7d9882948e7b837c232da5a"}, -] sphinxcontrib-applehelp = [ {file = "sphinxcontrib-applehelp-1.0.2.tar.gz", hash = "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58"}, {file = "sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a"}, diff --git a/manager/pyproject.toml b/manager/pyproject.toml index ed3aab188..6f87d0036 100644 --- a/manager/pyproject.toml +++ b/manager/pyproject.toml @@ -33,12 +33,11 @@ toml = "^0.10.2" debugpy = "^1.2.1" apkg = { git = "https://gitlab.nic.cz/packaging/apkg.git", branch = "master" } Sphinx = "^4.0.2" -sphinx-rtd-theme = "^0.5.2" [tool.poe.tasks] run = { cmd = "scripts/run", help = "Run the manager" } run-debug = { cmd = "scripts/run-debug", help = "Run the manager under debugger" } -docs = { cmd = "sphinx-build -M html docs docs/_build", help = "Create HTML documentation" } +docs = { cmd = "scripts/docs", help = "Create HTML documentation" } test = { cmd = "pytest --cov=knot_resolver_manager --show-capture=all tests/", help = "Run tests" } check = { cmd = "scripts/codecheck", help = "Run static code analysis" } format = { shell = "poetry run black knot_resolver_manager/ tests/; isort -rc .", help = "Run code formatter" } diff --git a/manager/scripts/docs b/manager/scripts/docs new file mode 100755 index 000000000..7cf197aed --- /dev/null +++ b/manager/scripts/docs @@ -0,0 +1,8 @@ +#!/bin/bash + +# ensure consistent behaviour +src_dir="$(dirname "$(realpath "$0")")" +source $src_dir/_env.sh + +# create HTML documentation +sphinx-build -M html docs docs/_build -- 2.47.3