Skip to content

Commit

Permalink
fix: add Copyright info and modify theme options
Browse files Browse the repository at this point in the history
  • Loading branch information
Kohulan committed Jul 6, 2023
1 parent e27a11d commit 779dac0
Showing 1 changed file with 40 additions and 16 deletions.
56 changes: 40 additions & 16 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,23 @@
import sys

sys.path.insert(0, os.path.abspath(".."))
import RanDepict
from datetime import datetime

# -- Project information -----------------------------------------------------

project = "RanDepict"
copyright = "2022, Otto Brinkhaus & Kohulan Rajan"
version = RanDepict.__version__
current_year = datetime.today().year
copyright = "2021-{}, Otto Brinkhaus & Kohulan Rajan at the Friedrich Schiller University Jena".format(
current_year
)
author = "Otto Brinkhaus & Kohulan Rajan"

# The full version, including alpha/beta/rc tags
release = "1.1.8"
rst_prolog = """
.. |current_year| replace:: {}
""".format(
current_year
)

# -- General configuration ---------------------------------------------------

Expand All @@ -35,8 +43,8 @@
"sphinx.ext.autosummary",
"nbsphinx",
"sphinx.ext.mathjax",
'sphinx.ext.githubpages',
"sphinx.ext.viewcode"
"sphinx.ext.githubpages",
"sphinx.ext.viewcode",
]

# Add any paths that contain templates here, relative to this directory.
Expand All @@ -46,10 +54,10 @@
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = ".rst"

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand All @@ -65,34 +73,50 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'furo'
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
# documentation.
#
#
html_theme_options = {
"light_css_variables": {
"color-brand-primary": "red",
"color-brand-content": "#CC3333",
"color-admonition-background": "orange",
"color-brand-primary": "#64C0D1",
"color-brand-content": "#E37B74",
"color-code-background": "#F8F8F8",
"color-code-border": "#E37B74",
"color-admonition-background": "#FEECEC",
"color-link": "#E37B74",
"color-pre-background": "#F8F8F8",
"color-pre-border": "#E37B74",
},
"dark_css_variables": {
"color-brand-primary": "#64C0D1",
"color-brand-content": "#E37B74",
"color-code-background": "#222222",
"color-code-border": "#E37B74",
"color-admonition-background": "#331E1C",
"color-link": "#E37B74",
"color-pre-background": "#222222",
"color-pre-border": "#E37B74",
},
"sidebar_hide_name": True,
"navigation_with_keys": True,
"top_of_page_button": "edit",
}


# 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,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_favicon = '_static/Untitled-1.png'
html_logo = '_static/Untitled-1.png'
html_static_path = ["_static"]
html_favicon = "_static/Untitled-1.png"
html_logo = "_static/Untitled-1.png"
# 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']``.

0 comments on commit 779dac0

Please sign in to comment.