Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Furo documentation #134

Merged
merged 2 commits into from
Nov 6, 2022
Merged

Furo documentation #134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
775c259
Furo documentation
ewjoachim Nov 6, 2022
a91a68c
Update token.py
ewjoachim Nov 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 12 additions & 23 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,13 @@
extensions = [
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx_autodoc_typehints",
"sphinx_github_changelog",
]

napoleon_numpy_docstring = True


# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

Expand All @@ -58,12 +62,17 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_material"
html_theme = "furo"

html_sidebars = {
"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
html_theme_options = {
"source_repository": "https://github.com/pradyunsg/furo/",
"source_branch": "main",
"source_directory": "docs/",
}

pygments_style = "sphinx"
pygments_dark_style = "monokai"

html_logo = "macaroon.png"
html_logo_text = "macaroon by Izwar Muis from the Noun Project"
html_favicon = "favicon.ico"
Expand All @@ -72,23 +81,3 @@
# 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_theme_options = {
# Set the name of the project to appear in the navigation.
"nav_title": "PyPIToken",
# Specify a base_url used to generate sitemap.xml. If not
# specified, then no sitemap will be built.
"base_url": "https://pypitoken.readthedocs.io/",
# Set the color and the accent color
"color_primary": "indigo",
"color_accent": "light-blue",
# Set the repo location to get a badge with stats
"repo_url": "https://github.com/ewjoachim/pypitoken",
"repo_name": "PyPIToken",
# Visible levels of the global TOC; -1 means unlimited
"globaltoc_depth": 2,
# If False, expand all TOC entries
"globaltoc_collapse": False,
# If True, show hidden TOC entries
"globaltoc_includehidden": False,
}
Loading