Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Catching proposed_changes up to main #79

Merged
merged 9 commits into from
Oct 8, 2024
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Defining the exact version will make sure things don't break
#sphinx<6
sphinx-rtd-theme>1.2
sphinx-rtd-theme==2.1.0rc2


# Adding sphinx-tabs extension
Expand Down
7 changes: 7 additions & 0 deletions docs/source/_templates/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
{% extends '!footer.html' %}

{% block extrafooter %} {{super}}
<!-- Adding GitHub link start-->
{% if display_github %}
<a href="https://github.com/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}.rst">
View on GitHub.</a>
{% endif %}
<!-- Adding GitHub link end -->

<!-- OneTrust Cookies Settings button start -->
<button id="cookie-button" class="ot-sdk-show-settings">About Cookies</button>
<!-- OneTrust Cookies Settings button end -->
Expand Down
24 changes: 24 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,29 @@
release = '0.1'
version = '0.1.0'

# RTD recommended config file additions

import os

# Define the canonical URL if you are using a custom domain on Read the Docs
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")

# Tell Jinja2 templates the build is running on Read the Docs
if os.environ.get("READTHEDOCS", "") == "True":
if "html_context" not in globals():
html_context = {}
html_context["READTHEDOCS"] = True

# Restoring GitHub link

html_context = {
"display_github": True, # Integrate GitHub
"github_user": "ncsa", # Username
"github_repo": "Nightingale_real", # Repo name
"github_version": os.environ.get("READTHEDOCS_GIT_IDENTIFIER"), # Version
"conf_py_path": "/docs/source/", # Path in the checkout to the docs root
}

# -- General configuration

extensions = [
Expand Down Expand Up @@ -52,6 +75,7 @@
html_theme_options = {
'logo_only': False,
'display_version': False,
'flyout_display': 'attached',
}

# -- Page Title
Expand Down