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

Added Google Analytics to documentation #165

Merged
merged 21 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [Unreleased]
### Added
- Google Analytics to the documentation site [#164](https://github.com/IN-CORE/pyincore-viz/issues/164)

## [1.10.0] - 2023-02-07
### Added
- Plot method for local hazard [#153](https://github.com/IN-CORE/pyincore-viz/issues/153)
Expand Down
5 changes: 5 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,20 @@ WORKDIR /src
COPY environment.yml ./
ENV PATH "$MAMBA_ROOT_PREFIX/bin:$PATH"
RUN micromamba install -y -n base -c conda-forge -c in-core \
beautifulsoup4 \
sphinx=6.2.1 sphinx_rtd_theme -f environment.yml

# copy code and generate documentation
COPY . ./
RUN sphinx-build -v -b html docs/source docs/build

# Run the insert_ga_to_header.py script to insert Google Analytics code
RUN python /src/docs/source/insert_ga_to_header.py

# ----------------------------------------------------------------------
# Building actual container
# ----------------------------------------------------------------------
FROM nginx

COPY --from=builder /src/docs/build/ /usr/share/nginx/html/doc/pyincore_viz/
COPY config /usr/share/nginx/html/doc/pyincore_viz/config
3 changes: 3 additions & 0 deletions config/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"GA_KEY": "Test-Google-Analytics-Key-Replace-Me"
}
31 changes: 31 additions & 0 deletions config/googleAnalytics.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// analytics.js
(function() {
// Fetch the runtime configuration
fetch('config/config.json')
.then(response => {
if (!response.ok) {
throw new Error('Configuration file not found');
}
return response.json();
})
.then(config => {
if (!config.GA_KEY) {
throw new Error('GA_KEY is missing in the configuration');
}

// Create the script tag for Google Tag Manager
const scriptTag = document.createElement('script');
scriptTag.async = true;
scriptTag.src = `https://www.googletagmanager.com/gtag/js?id=${config.GA_KEY}`;
document.head.appendChild(scriptTag);

// Initialize Google Analytics
window.dataLayer = window.dataLayer || [];

function gtag() { dataLayer.push(arguments); }

gtag('js', new Date());
gtag('config', config.GA_KEY);
})
.catch(error => console.warn('GA setup skipped:', error.message));
})();
46 changes: 46 additions & 0 deletions docs/source/insert_ga_to_header.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import os
from bs4 import BeautifulSoup

# Directory containing the built HTML files
build_dir = "docs/build"

# Google Analytics code snippet to insert into the HTML files
ga_code = f"""
<script>
// Fetch and execute the analytics script
fetch('config/googleAnalytics.js')
.then(response => response.text())
.then(scriptContent => {{
const scriptTag = document.createElement('script');
scriptTag.textContent = scriptContent;
document.head.appendChild(scriptTag);
}})
.catch(error => console.error('Failed to load analytics script:', error));
</script>
"""

# Loop through each HTML file in the build directory
for filename in os.listdir(build_dir):
if filename.endswith(".html"):
filepath = os.path.join(build_dir, filename)
print(f"Processing file: {filepath}")

# Read the content of the HTML file
with open(filepath, "r", encoding="utf-8") as file:
html_content = file.read()

# Parse HTML content using BeautifulSoup
soup = BeautifulSoup(html_content, "html.parser")

# Find the <head> tag and insert the Google Analytics code before it
head_tag = soup.find("head")
if head_tag:
print(f"Found <head> tag in {filename}:")
print("Inserting Google Analytics code...")
head_tag.insert(0, BeautifulSoup(ga_code, "html.parser"))

# Write the modified HTML content back to the file
with open(filepath, "w", encoding="utf-8") as file:
file.write(str(soup))

print("Google Analytics code insertion completed.")
Loading