Skip to content

Commit

Permalink
Revert commit editing docs/conf.py
Browse files Browse the repository at this point in the history
Changes should be made in docs/custom_conf.py where possible.

Enable custom_rst_epilog in docs/custom_conf.py (set to an empty string)
in lieu of removing rst_epilog from docs/conf.py (this commit restores
rst_epilog to docs/conf.py).

Remove global ruff: noqa directive for docs/conf.py -- ruff linting for
this file is already disabled in pyproject.toml
  • Loading branch information
james-garner-canonical committed Aug 22, 2024
1 parent 360345b commit aa7e9e7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# ruff: noqa
import sys
import os

Expand Down Expand Up @@ -99,6 +98,12 @@
]
exclude_patterns.extend(custom_excludes)

rst_epilog = '''
.. include:: /reuse/links.txt
'''
if 'custom_rst_epilog' in locals():
rst_epilog = custom_rst_epilog

source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
Expand Down
2 changes: 1 addition & 1 deletion docs/custom_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ def _compute_navigation_tree(context):
# Specify a reST string that is included at the end of each file.
# If commented out, use the default (which pulls the reuse/links.txt
# file into each reST file).
# custom_rst_epilog = ''
custom_rst_epilog = ''

# By default, the documentation includes a feedback button at the top.
# You can disable it by setting the following configuration to True.
Expand Down

0 comments on commit aa7e9e7

Please sign in to comment.