Brainbreak doc updates, including a funky placeholder logo. ;-)
This commit is contained in:
parent
a87a9d0ae7
commit
2e0d7ba74e
3 changed files with 19 additions and 2 deletions
|
|
@ -44,7 +44,7 @@ __email__ = "ntoll@ntoll.org"
|
|||
|
||||
#: The unique USB vendor ID for Adafruit boards.
|
||||
VENDOR_ID = 9114
|
||||
#: The regex used to extract __version__ and __repo__ assignments within code.
|
||||
#: The regex used to extract ``__version__`` and ``__repo__`` assignments.
|
||||
DUNDER_ASSIGN_RE = re.compile(r"""^__\w+__\s*=\s*['"].+['"]$""")
|
||||
|
||||
|
||||
|
|
@ -126,7 +126,6 @@ def get_repos_file(repository, filename):
|
|||
:param str repository: The full path to the GitHub repository.
|
||||
:param str filename: The name of the file within the GitHub repository.
|
||||
:return: The content of the file.
|
||||
:raises ValueError: if the repository or filename is unknown.
|
||||
"""
|
||||
# Extract the repository's path for the GitHub API.
|
||||
owner, repos_name = repository.split("/")[-2:]
|
||||
|
|
|
|||
18
docs/conf.py
18
docs/conf.py
|
|
@ -59,3 +59,21 @@ html_theme = 'alabaster'
|
|||
# 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_logo = 'logo.png'
|
||||
|
||||
html_theme_options = {
|
||||
'description': "The CircuitPython Library Updater",
|
||||
'logo_name': True,
|
||||
'logo_text_align': 'center',
|
||||
'github_user': 'adafruit',
|
||||
'github_repo': 'circup',
|
||||
'page_width': '1200px',
|
||||
}
|
||||
|
||||
html_sidebars = {
|
||||
'**': [
|
||||
'about.html',
|
||||
'searchbox.html',
|
||||
]
|
||||
}
|
||||
|
|
|
|||
BIN
docs/logo.png
Normal file
BIN
docs/logo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
Loading…
Reference in a new issue