Skip to content

Commit

Permalink
Fix docs building warnings, pin sphinx version
Browse files Browse the repository at this point in the history
Fix several warnings raised during the docs building.
Pin exact `sphinx` version to prevent import failures.
Extra `requirements.txt` and `mock` are no more needed.
  • Loading branch information
psss committed Sep 8, 2023
1 parent 9ef576c commit c38d318
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 15 deletions.
4 changes: 4 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@ python:
- method: pip
path: .
extra_requirements: [all]

build:
os: ubuntu-22.04
tools:
python: "3.11"
apt_packages:
- python3-dev
- libkrb5-dev
22 changes: 12 additions & 10 deletions did/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -491,16 +491,18 @@ def get_token(
wide mechanism to retrieve tokens or secrets either directly from
the config file as plain text or from an outsourced file.
Returns:
str: The stripped token or `None` if no or only empty entries
were found in the `config` dict.
Keyword Args:
config (dict): A configuration dictionary
token_key (str): The dict entry to look for when the token is
stored as plain text in the config
token_file_key (str): The dict entry to look for when the token
is supposed to be read from file
:param config:
A configuration dictionary.
:param token_key:
The dict entry to look for when the token is stored as plain
text in the config.
:param token_file_key:
The dict entry to look for when the token is supposed to be read
from file.
:returns:
The stripped token or `None` if no or only empty entries were
found in the `config` dict.
"""
token = None

Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down
3 changes: 0 additions & 3 deletions docs/requirements.txt

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
extras_require = {
'bodhi': ['bodhi-client'],
'bugzilla': ['python-bugzilla'],
'docs': ['sphinx>3', 'mock', 'sphinx_rtd_theme'],
'docs': ['sphinx==7.2.4', 'sphinx-rtd-theme==1.3.0'],
'google': ['google-api-python-client', 'oauth2client'],
'jira': ['requests_gssapi'],
'koji': ['koji'],
Expand Down

0 comments on commit c38d318

Please sign in to comment.