Skip to content

Commit

Permalink
Merge pull request #12 from CarletonURocketry/doxygen-css
Browse files Browse the repository at this point in the history
Saer's pretty Doxygen CSS is now included in fetcher.
  • Loading branch information
linguini1 authored Dec 1, 2023
2 parents 3d825bb + 38eaf0e commit 7809214
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 7 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "doxygen-awesome-css"]
path = doxygen-awesome-css
url = https://github.com/jothepro/doxygen-awesome-css.git
16 changes: 9 additions & 7 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ PROJECT_BRIEF = "A command line utility for reading sensor data over I2
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.

PROJECT_LOGO =
PROJECT_LOGO = ./doxygen-custom/inspacelogo.png

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
Expand Down Expand Up @@ -361,7 +361,7 @@ MARKDOWN_SUPPORT = YES
# Minimum value: 0, maximum value: 99, default value: 5.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.

TOC_INCLUDE_HEADINGS = 5
TOC_INCLUDE_HEADINGS = 0

# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
# generate identifiers for the Markdown headings. Note: Every identifier is
Expand Down Expand Up @@ -943,7 +943,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = src
INPUT = src README.md
INPUT += src/include

# This tag can be used to specify the character encoding of the source files
Expand Down Expand Up @@ -1115,7 +1115,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = README.md

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down Expand Up @@ -1324,7 +1324,7 @@ HTML_HEADER =
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_FOOTER =
HTML_FOOTER = doxygen-custom/footer.html

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
Expand Down Expand Up @@ -1354,7 +1354,9 @@ HTML_STYLESHEET =
# documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET =
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
doxygen-custom/custom.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand Down Expand Up @@ -1685,7 +1687,7 @@ DISABLE_INDEX = NO
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

GENERATE_TREEVIEW = NO
GENERATE_TREEVIEW = YES

# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
Expand Down
1 change: 1 addition & 0 deletions doxygen-awesome-css
Submodule doxygen-awesome-css added at df88fe
5 changes: 5 additions & 0 deletions doxygen-custom/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/* Resize to fix larger logo - formerly 335px x 120px */
html {
--side-nav-fixed-width: 350px;
--top-height: 150px;
}
10 changes: 10 additions & 0 deletions doxygen-custom/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<!--Not sure if this works, but we shall see-->
<div id="nav-path" class="navpath">
<ul>
<li class="footer">
<a href = "https://github.com/CarletonURocketry">
Copyleft &copy; <script>document.write(new Date().getFullYear())</script> CUInspace
</a>
</li>
</ul>
</div>
Binary file added doxygen-custom/inspacelogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7809214

Please sign in to comment.