Skip to content

Commit

Permalink
fix: docs error
Browse files Browse the repository at this point in the history
  • Loading branch information
syedsajjadkazmii committed Nov 28, 2024
1 parent 5baa361 commit c017435
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ def get_version(*file_paths):
# A list of warning types to suppress arbitrary warning messages.
suppress_warnings = [
'image.nonlocal_uri',
'role:setting',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -152,6 +151,7 @@ def get_version(*file_paths):
# This file is intended as a guide for developers browsing the source tree,
# not to be rendered into the output docs.
'decisions/README.rst',
'celery',
]

# The reST default role (used for this markup: `text`) to use for all
Expand Down Expand Up @@ -557,3 +557,9 @@ def setup(app):
"""Sphinx extension: run sphinx-apidoc."""
event = 'builder-inited'
app.connect(event, on_init)
app.add_role('setting', setting_role)

def setting_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
"""Custom role for :setting:."""
# Here, you can decide how the role should be rendered
return text

0 comments on commit c017435

Please sign in to comment.