Skip to content

Commit

Permalink
Merge pull request #428 from Kegbot/mikey/docs
Browse files Browse the repository at this point in the history
Update docs theme.
  • Loading branch information
mik3y authored Jul 21, 2022
2 parents 0105009 + 8c1edc3 commit 9f6b259
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 39 deletions.
40 changes: 3 additions & 37 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = ""
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://get.docker.sh/>`_ to run, and
runs on any operating system that supports Docker. We have tested these
Expand Down
73 changes: 72 additions & 1 deletion poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down

0 comments on commit 9f6b259

Please sign in to comment.