Skip to content

Commit

Permalink
Switched docs to a dark theme for cleaner visuals
Browse files Browse the repository at this point in the history
  • Loading branch information
marksweb committed Jun 9, 2021
1 parent 62d30d8 commit 2b46e5f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 25 deletions.
20 changes: 6 additions & 14 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,10 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
extensions = [
"sphinx_copybutton",
"sphinxext.opengraph",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -52,20 +55,9 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_sidebars = {
"**": [
"about.html",
"searchbox.html",
"navigation.html",
"relations.html",
]
}
html_theme = 'furo'
html_theme_options = {
"description": "SQL Explorer aims to make the flow of data between people fast, "
"simple, and confusion-free.",
"github_user": "groveco",
"github_repo": "django-sql-explorer",
"navigation_with_keys": True,
}
pygments_style = 'sphinx'

Expand Down
13 changes: 2 additions & 11 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,7 @@ Django SQL Explorer
:caption: Contents:

features.rst
history.rst
install.rst
dependencies.rst
settings.rst


******************
Indices and tables
******************

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
dependencies.rst
history.rst
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
django-sql-explorer>=2.0
furo
Sphinx>4
sphinx-copybutton
sphinxext-opengraph

0 comments on commit 2b46e5f

Please sign in to comment.