Skip to content

Commit

Permalink
Make config less likely to be copied
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric-Arellano committed Aug 22, 2024
1 parent a095b23 commit 1f3818c
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion example_docs/docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,15 @@
"source_repository": "https://github.com/Qiskit/qiskit_sphinx_theme/",
"source_branch": "main",
"source_directory": "example_docs/docs/",
"sidebar_qiskit_ecosystem_member": True,
}

# Members of the Qiskit ecosystem should set `sidebar_qiskit_ecosystem_member`
# explicitly in `html_theme_options`. This convoluted code is only set up
# this way to discourage projects who copy this config file from
# unintentionally configuring this option.
if project == "Example Docs":
html_theme_options["sidebar_qiskit_ecosystem_member"] = True

# This allows including custom CSS and HTML templates.
html_static_path = ["_static"]
templates_path = ["_templates"]
Expand Down

0 comments on commit 1f3818c

Please sign in to comment.