Skip to content

Commit 725ecfc

Browse files
committed
add link to github repo
1 parent bb76743 commit 725ecfc

1 file changed

Lines changed: 27 additions & 9 deletions

File tree

docs/source/conf.py

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111
# Add the parent directory of the documentation root to sys.path
1212
sys.path.insert(0, os.path.abspath("../.."))
1313

14-
project = 'tika-python'
15-
copyright = '2024, Chris A. Mattmann'
16-
author = 'Chris A. Mattmann'
14+
project = "tika-python"
15+
copyright = "2024, Chris A. Mattmann"
16+
author = "Chris A. Mattmann"
1717

1818
# -- General configuration ---------------------------------------------------
1919
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -26,16 +26,34 @@
2626
"sphinx.ext.autosectionlabel",
2727
"sphinx.ext.todo",
2828
"sphinx.ext.duration",
29-
"myst_parser"
29+
"myst_parser",
3030
]
3131

32-
templates_path = ['_templates']
33-
exclude_patterns = ['tika.tests*']
34-
32+
templates_path = ["_templates"]
33+
exclude_patterns = ["tika.tests*"]
3534

3635

3736
# -- Options for HTML output -------------------------------------------------
3837
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3938

40-
html_theme = 'furo'
41-
html_static_path = ['_static']
39+
html_theme = "furo"
40+
html_static_path = ["_static"]
41+
html_theme_options = {
42+
"source_repository": "https://github.com/chrismattmann/tika-python",
43+
"source_branch": "master",
44+
"source_directory": "docs/source/",
45+
"footer_icons": [
46+
{
47+
"name": "GitHub",
48+
"url": "https://github.com/chrismattmann/tika-python",
49+
# Embedded SVG instructions from furo docs
50+
# Ref: https://pradyunsg.me/furo/customisation/footer/#configuration
51+
"html": """
52+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
53+
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
54+
</svg>
55+
""",
56+
"class": "",
57+
},
58+
],
59+
}

0 commit comments

Comments
 (0)