Skip to content

Commit 955e835

Browse files
committed
docs: update sphinx configuration
1 parent a0abfc1 commit 955e835

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

docs/conf.py

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,17 @@
1212
#
1313
import os
1414
import sys
15-
sys.path.insert(0, os.path.abspath('../sw360'))
15+
current_dir = os.path.dirname(__file__)
16+
target_dir = os.path.abspath(os.path.join(current_dir, "../sw360"))
17+
sys.path.insert(0, target_dir)
18+
target2 = os.path.abspath(os.path.join(current_dir, "../"))
19+
sys.path.insert(0, target2)
1620

1721

1822
# -- Project information -----------------------------------------------------
1923

2024
project = 'Python interface for SW360'
21-
copyright = '2020, Thomas Graf'
25+
copyright = '2020, Siemens AG'
2226
author = 'Thomas Graf'
2327

2428

@@ -27,15 +31,15 @@
2731
# Add any Sphinx extension module names here, as strings. They can be
2832
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
2933
# ones.
30-
extensions = ['sphinx.ext.autodoc']
34+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary']
3135

3236
# Add any paths that contain templates here, relative to this directory.
3337
templates_path = ['_templates']
3438

3539
# List of patterns, relative to source directory, that match files and
3640
# directories to ignore when looking for source files.
3741
# This pattern also affects html_static_path and html_extra_path.
38-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
42+
exclude_patterns = []
3943

4044

4145
# -- Options for HTML output -------------------------------------------------
@@ -44,8 +48,18 @@
4448
# a list of builtin themes.
4549
#
4650
html_theme = 'alabaster'
51+
html_theme_options = {
52+
"github_user": "sw360",
53+
"github_repo": "sw360python",
54+
"github_button": True,
55+
"fixed_sidebar": True,
56+
"extra_nav_links": {
57+
"Package on PyPi": "https://pypi.org/project/sw360/",
58+
"Source on Github": "https://github.com/sw360/sw360python/",
59+
},
60+
}
4761

4862
# Add any paths that contain custom static files (such as style sheets) here,
4963
# relative to this directory. They are copied after the builtin static files,
5064
# so a file named "default.css" will overwrite the builtin "default.css".
51-
html_static_path = ['_static']
65+
# html_static_path = ['_static']

0 commit comments

Comments
 (0)