Skip to content

Commit

Permalink
sphinx-immaterial docs theme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-akhmetov committed Jun 23, 2024
1 parent e3b598a commit 56905b4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sphinx
sphinx-autobuild
autodoc
sphinx-immaterial
16 changes: 10 additions & 6 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
# -- Project information -----------------------------------------------------

project = "python-telegram"
copyright = "2018, Alexander Akhmetov"
copyright = "2024, Alexander Akhmetov"
author = "Alexander Akhmetov"

html_show_sourcelink = False
Expand All @@ -41,9 +41,7 @@
# 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.ext.autodoc",
]
extensions = ["sphinx.ext.autodoc", "sphinx_immaterial"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down Expand Up @@ -78,7 +76,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "alabaster"
html_theme = "sphinx_immaterial"

# 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 @@ -98,6 +96,10 @@
"PyPi": "https://pypi.org/project/python-telegram/",
"2": "",
},
"palette": {
"primary": "deep-orange",
"accent": "deep-orange",
},
}

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down Expand Up @@ -163,7 +165,9 @@

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "python-telegram", "python-telegram Documentation", [author], 1)]
man_pages = [
(master_doc, "python-telegram", "python-telegram Documentation", [author], 1)
]


# -- Options for Texinfo output ----------------------------------------------
Expand Down

0 comments on commit 56905b4

Please sign in to comment.