Skip to content
This repository was archived by the owner on Jun 11, 2024. It is now read-only.

Commit 5f1fc77

Browse files
committed
add atomx logo and favicon to documentation
1 parent eb0df69 commit 5f1fc77

4 files changed

Lines changed: 15 additions & 7 deletions

File tree

docs/_static/favicon.ico

6.37 KB
Binary file not shown.

docs/_static/logo.png

1.9 KB
Loading

docs/conf.py

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,26 +119,34 @@
119119
# Theme options are theme-specific and customize the look and feel of a theme
120120
# further. For a list of options available for each theme, see the
121121
# documentation.
122-
#html_theme_options = {}
122+
html_theme_options = {
123+
'logo': 'logo.png',
124+
'logo_name': 'Python Atomx API',
125+
'github_user': 'atomx',
126+
'github_repo': 'atomx-api-python',
127+
'github_banner': True,
128+
'show_powered_by': False,
129+
'show_related': True,
130+
}
123131

124132
# Add any paths that contain custom themes here, relative to this directory.
125133
#html_theme_path = []
126134

127135
# The name for this set of Sphinx documents. If None, it defaults to
128136
# "<project> v<release> documentation".
129-
#html_title = None
137+
html_title = 'Python Atomx API'
130138

131139
# A shorter title for the navigation bar. Default is the same as html_title.
132140
#html_short_title = None
133141

134142
# The name of an image file (relative to this directory) to place at the top
135143
# of the sidebar.
136-
#html_logo = None
144+
html_logo = '_static/logo.png'
137145

138146
# The name of an image file (within the static path) to use as favicon of the
139147
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
140148
# pixels large.
141-
#html_favicon = None
149+
html_favicon = 'favicon.ico'
142150

143151
# Add any paths that contain custom static files (such as style sheets) here,
144152
# relative to this directory. They are copied after the builtin static files,
@@ -175,7 +183,7 @@
175183
#html_split_index = False
176184

177185
# If true, links to the reST sources are added to the pages.
178-
#html_show_sourcelink = True
186+
html_show_sourcelink = False
179187

180188
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
181189
#html_show_sphinx = True

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _index:
22

33

4-
Documentation for the python interface to the atomx api
5-
=======================================================
4+
Python interface to atomx
5+
=========================
66

77
Contents:
88

0 commit comments

Comments
 (0)