Merge pull request #92 from NodeJSmith/feature/bit_of_improvement_to_docs

Feature/bit of improvement to docs

Author: NodeJSmith

.bumpversion.toml

@@ -22,3 +22,8 @@ replace = 'version = "{new_version}"'
 filename = "src/otf_api/__init__.py"
 search = '__version__ = "{current_version}"'
 replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "source/conf.py"
+search = 'release = "{current_version}"'
+replace = 'release = "{new_version}"'

source/_static/custom.css

@@ -0,0 +1,11 @@
+footer {
+    margin-top: 0.5rem;
+    margin-bottom: 0.5rem;
+}
+
+footer .disclaimer {
+    margin-top: 0;
+    font-size: 0.85em;
+    color: #666;
+    text-align: center;
+}

source/_templates/page.html

@@ -0,0 +1,12 @@
+{% extends "!page.html" %}
+
+{%- block footer -%}
+{{- super() -}}
+<footer>
+    <p class="disclaimer">
+        <strong>Disclaimer:</strong>
+        This project is not affiliated with, endorsed by, or supported by Orangetheory Fitness. It is an independent,
+        unofficial client for interacting with Orangetheory's services. Use at your own risk.
+    </p>
+</footer>
+{%- endblock -%}

source/api/otf_api.rst

@@ -1,5 +1,5 @@
 Otf API Code Reference
-================
+========================
 
 .. toctree::
    :maxdepth: 4

source/conf.py

@@ -34,7 +34,7 @@
 
 templates_path = ["_templates"]
 exclude_patterns = []
-
+html_css_files = ["custom.css"]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

source/index.rst

@@ -30,7 +30,3 @@ You can also export the environment variables ``OTF_EMAIL`` and ``OTF_PASSWORD``
    from otf_api import Otf, OtfUser
 
    otf = Otf(user=OtfUser(<email_address>, <password>))
-
-
-**Disclaimer:**
-This project is not affiliated with, endorsed by, or supported by Orangetheory Fitness. It is an independent, unofficial client for interacting with Orangetheory's services. Use at your own risk.