Skip to content

Commit 351d66e

Browse files
authored
Added html context
1 parent e9c0fe0 commit 351d66e

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/conf.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
# If extensions (or modules to document with autodoc) are in another directory,
1010
# add these directories to sys.path here. If the directory is relative to the
1111
# documentation root, use os.path.abspath to make it absolute, like shown here.
12-
#
1312
import os
1413
import sys
1514

@@ -48,9 +47,18 @@
4847

4948
# The theme to use for HTML and HTML Help pages. See the documentation for
5049
# a list of builtin themes.
51-
#
5250
html_theme = "sphinx_rtd_theme"
5351

52+
# Adds "edit source: links
53+
# Source: https://docs.readthedocs.io/en/stable/guides/edit-source-links-sphinx.html
54+
html_context = {
55+
"display_github": True, # Integrate GitHub
56+
"github_user": "TheRenegadeCoder", # Username
57+
"github_repo": "SnakeMD", # Repo name
58+
"github_version": "main", # Version
59+
"conf_py_path": "/docs/", # Path in the checkout to the docs root
60+
}
61+
5462
# Add any paths that contain custom static files (such as style sheets) here,
5563
# relative to this directory. They are copied after the builtin static files,
5664
# so a file named "default.css" will overwrite the builtin "default.css".

0 commit comments

Comments
 (0)