Skip to content

Commit

Permalink
feat(docs): enable feedback button
Browse files Browse the repository at this point in the history
  • Loading branch information
erinecon authored and medubelko committed Feb 7, 2025
1 parent 92111c5 commit 1ab7b2c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
html_context = {
"product_page": "github.com/canonical/charmcraft",
"github_url": "https://github.com/canonical/charmcraft",
"github_issues": "https://github.com/canonical/charmcraft/issues",
"discourse": "https://discourse.charmhub.io",
}

Expand Down Expand Up @@ -184,3 +185,11 @@ def setup(app):
craft_parts_docs_path = pathlib.Path(craft_parts_docs.__file__).parent / "craft-parts"
(common_docs_path / "craft-parts").unlink(missing_ok=True)
(common_docs_path / "craft-parts").symlink_to(craft_parts_docs_path, target_is_directory=True)

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

html_js_files = ['header-nav.js']
if 'github_issues' in html_context and html_context['github_issues'] and not disable_feedback_button:
html_js_files.append('github_issue_links.js')

0 comments on commit 1ab7b2c

Please sign in to comment.