Skip to content

Updating Documentation for Webpage #4

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.

Sign up for GitHub

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

Merged
SpinnerX merged 3 commits into from
Nov 4, 2025
Merged

Updating Documentation for Webpage #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9338cf2
Updated webpages
Nov 3, 2025
05ada6d
Added custom CSS layout to working docs webpage
Nov 4, 2025
3acddd6
Updated doxygen configuration and scripts to generating the documenta…
Nov 4, 2025
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
6 changes: 5 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,8 @@ sphinx/output/


mkdocs/api
library_merger_devel.sh
library_merger_devel.sh

mkdocs/html/
TheAtlasEngine
docs/
23 changes: 0 additions & 23 deletions Doxyfile.in
View file
Open in desktop

This file was deleted.

31 changes: 31 additions & 0 deletions apply_css.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#!/bin/bash

# Script to inject custom CSS into all Doxygen HTML files
# To execute this script, run: ./apply_css.sh
# This script will inject the custom CSS into all Doxygen HTML files in the mkdocs/html directory

# HTML directory containing the Doxygen HTML files
HTML_DIR="mkdocs/html"
# CSS file to inject into the Doxygen HTML files
CSS_FILE="css_themes/general.css"

# Find all HTML files and inject the CSS link after doxygen.css
find "$HTML_DIR" -name "*.html" -type f | while read html_file; do
# Check if the CSS link is already present
if ! grep -q "$CSS_FILE" "$html_file"; then
# Insert the custom CSS link after doxygen.css
if [[ "$OSTYPE" == "darwin"* ]]; then
# macOS
sed -i '' '/doxygen.css/a\
<link href="doxygen-custom.css" rel="stylesheet" type="text/css" />
' "$html_file"
else
# Linux
sed -i '/doxygen.css/a <link href="doxygen-custom.css" rel="stylesheet" type="text/css" />' "$html_file"
fi
echo "Injected CSS into: $html_file"
fi
done

echo "Custom CSS injection complete!"

40 changes: 39 additions & 1 deletion build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,39 @@
git clone https://github.com/engine3d-dev/TheAtlasEngine

# This script generates the docs html files required for the documentation web-page

# Sets up the virtual environment
python3 -m venv venv

source venv/bin/activate


pip install -r requirements.txt


# Generate doxygen

# cd TheAtlasEngine
# doxygen -g Doxyfile
# Modify PROJECT_NAME
# Modify INPUT = ./TheAtlasEngine/atlas
# Modify RECURSIVE = YES
# Modify OUTPUT_DIRECTORY docs
# doxygen TheAtlasEngine/Doxyfile
# Then add that to mkdocs

# Cloning the TheAtlasEngine repository
git clone https://github.com/engine3d-dev/TheAtlasEngine

# We check if TheAtlasEngine directory exists then we remove it and re-clone repository again
if ! [ -d TheAtlasEngine ]; then
git clone https://github.com/engine3d-dev/TheAtlasEngine
else
rm -rf TheAtlasEngine
git clone https://github.com/engine3d-dev/TheAtlasEngine
fi

# Generating the doxygen documentation from the specified Doxyfile in the repository
doxygen TheAtlasEngine/Doxyfile

# Copying the doxygen documentation to the mkdocs/html directory
cp -R doxygen_output/html mkdocs/html
Loading