From 8c1edc358c43b9fd5e248f10c25b1cacc69445b1 Mon Sep 17 00:00:00 2001 From: mike wakerly Date: Thu, 21 Jul 2022 12:30:33 +0100 Subject: [PATCH] Update docs theme. --- docs/source/conf.py | 40 ++-------------------- docs/source/overview.rst | 2 +- poetry.lock | 73 +++++++++++++++++++++++++++++++++++++++- pyproject.toml | 1 + 4 files changed, 77 insertions(+), 39 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 79f38bab0..a15d0ed0f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,10 +18,9 @@ # -- Project information ----------------------------------------------------- - project = "Kegbot Server" -copyright = "2020, Kegbot Project" -author = "Kegbot Project" +copyright = "2022, The Kegbot Project Contributors" +author = "The Kegbot Project Contributors" # The short X.Y version version = "" @@ -53,37 +52,15 @@ # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = ".rst" - # The master toctree document. master_doc = "index" -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = None - - # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "alabaster" +html_theme = "furo" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -96,17 +73,6 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these templates by -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', -# 'searchbox.html']``. -# -# html_sidebars = {} - - # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 2ce33b4c2..723ba5551 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -8,7 +8,7 @@ and web UI for a Kegbot system. These instructions will guide you through installing a new Kegbot server. Prerequisites ------------- +------------- Kegbot Server requires `Docker `_ to run, and runs on any operating system that supports Docker. We have tested these diff --git a/poetry.lock b/poetry.lock index 67eaaa7bb..d5d5a158b 100644 --- a/poetry.lock +++ b/poetry.lock @@ -77,6 +77,21 @@ python-versions = ">=3.6" [package.dependencies] pytz = ">=2015.7" +[[package]] +name = "beautifulsoup4" +version = "4.11.1" +description = "Screen-scraping library" +category = "dev" +optional = false +python-versions = ">=3.6.0" + +[package.dependencies] +soupsieve = ">1.2" + +[package.extras] +html5lib = ["html5lib"] +lxml = ["lxml"] + [[package]] name = "billiard" version = "3.6.4.0" @@ -420,6 +435,27 @@ python-versions = ">=3.6" [package.dependencies] python-dateutil = ">=2.7" +[[package]] +name = "furo" +version = "2022.6.21" +description = "A clean customisable Sphinx documentation theme." +category = "dev" +optional = false +python-versions = ">=3.7" +develop = false + +[package.dependencies] +beautifulsoup4 = "*" +pygments = "*" +sphinx = ">=4.0,<6.0" +sphinx-basic-ng = "*" + +[package.source] +type = "git" +url = "https://github.com/Kegbot/furo" +reference = "kegbot/kegbot" +resolved_reference = "493cf3b4a44c8038c1aa0efa3d2aff8ff12b742c" + [[package]] name = "future" version = "0.18.2" @@ -928,6 +964,14 @@ category = "dev" optional = false python-versions = "*" +[[package]] +name = "soupsieve" +version = "2.3.2.post1" +description = "A modern CSS selector implementation for Beautiful Soup." +category = "dev" +optional = false +python-versions = ">=3.6" + [[package]] name = "sphinx" version = "5.0.2" @@ -959,6 +1003,20 @@ docs = ["sphinxcontrib-websupport"] lint = ["flake8 (>=3.5.0)", "isort", "mypy (>=0.950)", "docutils-stubs", "types-typed-ast", "types-requests"] test = ["pytest (>=4.6)", "html5lib", "cython", "typed-ast"] +[[package]] +name = "sphinx-basic-ng" +version = "0.0.1a12" +description = "A modern skeleton for Sphinx themes." +category = "dev" +optional = false +python-versions = ">=3.7" + +[package.dependencies] +sphinx = ">=4.0,<6.0" + +[package.extras] +docs = ["furo", "myst-parser", "sphinx-copybutton", "sphinx-inline-tabs", "ipython"] + [[package]] name = "sphinx-issues" version = "3.0.1" @@ -1164,7 +1222,7 @@ testing = ["coverage (>=5.0.3)", "zope.event", "zope.testing"] [metadata] lock-version = "1.1" python-versions = "^3.10.5" -content-hash = "82ef1bb3942b5c6262c3c92a592a85ac26264c6ef16619a46d9125f08dac9d5f" +content-hash = "b160a410086d9012b030987c57b57f407191ed412f9d9f3ecae457ba3e0e420c" [metadata.files] addict = [ @@ -1198,6 +1256,10 @@ babel = [ {file = "Babel-2.10.3-py3-none-any.whl", hash = "sha256:ff56f4892c1c4bf0d814575ea23471c230d544203c7748e8c68f0089478d48eb"}, {file = "Babel-2.10.3.tar.gz", hash = "sha256:7614553711ee97490f732126dc077f8d0ae084ebc6a96e23db1482afabdb2c51"}, ] +beautifulsoup4 = [ + {file = "beautifulsoup4-4.11.1-py3-none-any.whl", hash = "sha256:58d5c3d29f5a36ffeb94f02f0d786cd53014cf9b3b3951d42e0080d8a9498d30"}, + {file = "beautifulsoup4-4.11.1.tar.gz", hash = "sha256:ad9aa55b65ef2808eb405f46cf74df7fcb7044d5cbc26487f96eb2ef2e436693"}, +] billiard = [ {file = "billiard-3.6.4.0-py3-none-any.whl", hash = "sha256:87103ea78fa6ab4d5c751c4909bcff74617d985de7fa8b672cf8618afd5a875b"}, {file = "billiard-3.6.4.0.tar.gz", hash = "sha256:299de5a8da28a783d51b197d496bef4f1595dd023a93a4f59dde1886ae905547"}, @@ -1385,6 +1447,7 @@ freezegun = [ {file = "freezegun-1.2.1-py3-none-any.whl", hash = "sha256:15103a67dfa868ad809a8f508146e396be2995172d25f927e48ce51c0bf5cb09"}, {file = "freezegun-1.2.1.tar.gz", hash = "sha256:b4c64efb275e6bc68dc6e771b17ffe0ff0f90b81a2a5189043550b6519926ba4"}, ] +furo = [] future = [ {file = "future-0.18.2.tar.gz", hash = "sha256:b1bead90b70cf6ec3f0710ae53a525360fa360d306a86583adc6bf83a4db537d"}, ] @@ -1868,10 +1931,18 @@ snowballstemmer = [ {file = "snowballstemmer-2.2.0-py2.py3-none-any.whl", hash = "sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a"}, {file = "snowballstemmer-2.2.0.tar.gz", hash = "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1"}, ] +soupsieve = [ + {file = "soupsieve-2.3.2.post1-py3-none-any.whl", hash = "sha256:3b2503d3c7084a42b1ebd08116e5f81aadfaea95863628c80a3b774a11b7c759"}, + {file = "soupsieve-2.3.2.post1.tar.gz", hash = "sha256:fc53893b3da2c33de295667a0e19f078c14bf86544af307354de5fcf12a3f30d"}, +] sphinx = [ {file = "Sphinx-5.0.2-py3-none-any.whl", hash = "sha256:d3e57663eed1d7c5c50895d191fdeda0b54ded6f44d5621b50709466c338d1e8"}, {file = "Sphinx-5.0.2.tar.gz", hash = "sha256:b18e978ea7565720f26019c702cd85c84376e948370f1cd43d60265010e1c7b0"}, ] +sphinx-basic-ng = [ + {file = "sphinx_basic_ng-0.0.1a12-py3-none-any.whl", hash = "sha256:e8b6efd2c5ece014156de76065eda01ddfca0fee465aa020b1e3c12f84570bbe"}, + {file = "sphinx_basic_ng-0.0.1a12.tar.gz", hash = "sha256:cffffb14914ddd26c94b1330df1d72dab5a42e220aaeb5953076a40b9c50e801"}, +] sphinx-issues = [ {file = "sphinx-issues-3.0.1.tar.gz", hash = "sha256:b7c1dc1f4808563c454d11c1112796f8c176cdecfee95f0fd2302ef98e21e3d6"}, {file = "sphinx_issues-3.0.1-py3-none-any.whl", hash = "sha256:8b25dc0301159375468f563b3699af7a63720fd84caf81c1442036fcd418b20c"}, diff --git a/pyproject.toml b/pyproject.toml index 8a5deaee5..bdcdd0a4f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -61,6 +61,7 @@ requests-mock = "*" sphinx-issues = "*" sphinx = "*" vcrpy = "*" +furo = {git = "https://github.com/Kegbot/furo", rev = "kegbot/kegbot"} [build-system] requires = ["poetry-core>=1.0.0"]