Skip to content

Commit 037553b

Browse files
authored
Merge pull request #13 from engine3d-dev/update_webpage
Update webpage
2 parents 2cfb74f + 80e2998 commit 037553b

File tree

5 files changed

+2258
-83
lines changed

5 files changed

+2258
-83
lines changed

Doxyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1398,7 +1398,7 @@ HTML_FOOTER =
13981398
# obsolete.
13991399
# This tag requires that the tag GENERATE_HTML is set to YES.
14001400

1401-
HTML_STYLESHEET =
1401+
HTML_STYLESHEET = css_themes/general.css
14021402

14031403
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
14041404
# cascading style sheets that are included after the standard style sheets
@@ -1416,7 +1416,7 @@ HTML_STYLESHEET =
14161416
# documentation.
14171417
# This tag requires that the tag GENERATE_HTML is set to YES.
14181418

1419-
HTML_EXTRA_STYLESHEET = doxygen-custom.css
1419+
HTML_EXTRA_STYLESHEET =
14201420

14211421
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
14221422
# other source files which should be copied to the HTML output directory. Note

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,13 @@ cd sphinx
5050
sphinx-build -b html -Dbreathe_projects.atlas=doxygen_output/xml . output
5151
```
5252

53+
# Contribution Instructions
54+
55+
56+
## CSS Layout Modifications
57+
58+
Whenever the CSS modifications are made. Manually reload the doxygen using the `./build.sh` script.
59+
5360

5461
## Resources
5562

build.sh

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11

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

4-
# Sets up the virtual environment
5-
python3 -m venv venv
4+
# # Sets up the virtual environment
5+
# python3 -m venv venv
66

7-
source venv/bin/activate
7+
# source venv/bin/activate
88

99

10-
pip install -r requirements.txt
10+
# pip install -r requirements.txt
1111

1212

13-
# Generate doxygen
13+
# # Generate doxygen
1414

1515
# cd TheAtlasEngine
1616
# doxygen -g Doxyfile
@@ -41,12 +41,26 @@ echo "ls TheAtlasEngine | grep \"Doxyfile\""
4141
echo "Output:"
4242
ls TheAtlasEngine | grep "Doxyfile"
4343

44-
# Generating the doxygen documentation from the specified Doxyfile in the repository
44+
# # Generating the doxygen documentation from the specified Doxyfile in the repository
4545
doxygen TheAtlasEngine/Doxyfile
4646

47-
# # Copying the doxygen documentation to the mkdocs/html directory
48-
cp -R docs/html mkdocs/html
47+
# # # Copying the doxygen documentation to the mkdocs/html directory
48+
# cp -R docs/html mkdocs/html
4949

5050

51-
chmod +x apply_css.sh
52-
./apply_css.sh
51+
if [ -d mkdocs/html ]; then
52+
rm -rf mkdocs/html
53+
echo "Deleted mkdocs/html directory"
54+
echo "Copying docs/html to mkdocs/html"
55+
cp -R docs/html mkdocs/html
56+
cp css_themes/*.css mkdocs/html/
57+
else
58+
echo "mkdocs/html directory not found"
59+
echo "Copying docs/html to mkdocs/html"
60+
cp -R docs/html mkdocs/html
61+
cp css_themes/*.css mkdocs/html/
62+
fi
63+
64+
65+
# chmod +x apply_css.sh
66+
# ./apply_css.sh

css_themes/general-old.css

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
/* CSS for UI elements (a.k.a. chrome) */
2-
31
@import 'variables.css';
42

53
::-webkit-scrollbar {

0 commit comments

Comments
 (0)