Skip to content

Commit

Permalink
Major improvements to Doxygen output
Browse files Browse the repository at this point in the history
  • Loading branch information
@reiniscirpons
reiniscirpons committed Apr 11, 2024
1 parent 4f98abc commit 3e59709
Show file tree
Hide file tree
Showing 6 changed files with 412 additions and 48 deletions.
1 change: 1 addition & 0 deletions Makefile.am
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1195,3 +1195,4 @@ lint:

doc:
cd docs && doxygen
cd docs && ./fixup.py
28 changes: 10 additions & 18 deletions docs/Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,7 @@ SORT_MEMBER_DOCS = YES
# this will also influence the order of the classes in the class list.
# The default value is: NO.

SORT_BRIEF_DOCS = NO
SORT_BRIEF_DOCS = YES

# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
Expand Down Expand Up @@ -954,11 +954,7 @@ WARN_LOGFILE =

INPUT = "../include/libsemigroups" \
"../README.md" \
"install.md" \
"Congruences.md" \
"Words.md" \
"WordGraphs.md" \
"KnuthBendix.md"
"install.md"

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -1334,7 +1330,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_HEADER = doxygen-awesome-css/doxygen-custom/header.html
HTML_HEADER = header.html

# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
Expand Down Expand Up @@ -1374,9 +1370,9 @@ HTML_STYLESHEET =
# documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
doxygen-awesome-css/doxygen-custom/custom.css \
doxygen-awesome-css/doxygen-custom/custom-alternative.css
HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
doxygen-awesome-css/doxygen-awesome-sidebar-only.css \
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 All @@ -1387,11 +1383,7 @@ HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES = doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \
doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js \
doxygen-awesome-css/doxygen-awesome-paragraph-link.js \
doxygen-awesome-css/doxygen-custom/toggle-alternative-theme.js \
doxygen-awesome-css/doxygen-awesome-interactive-toc.js \
doxygen-awesome-css/doxygen-awesome-tabs.js
doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js

# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
Expand Down Expand Up @@ -1445,7 +1437,7 @@ HTML_COLORSTYLE_GAMMA = 113
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_DYNAMIC_MENUS = YES
HTML_DYNAMIC_MENUS = NO

# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
# documentation will contain sections that can be hidden and shown after the
Expand Down Expand Up @@ -1796,7 +1788,7 @@ USE_MATHJAX = YES
# The default value is: MathJax_2.
# This tag requires that the tag USE_MATHJAX is set to YES.

MATHJAX_VERSION = MathJax_2
MATHJAX_VERSION = MathJax_3

# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. For more details about the output format see MathJax
Expand Down Expand Up @@ -1827,7 +1819,7 @@ MATHJAX_FORMAT = HTML-CSS
# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
# This tag requires that the tag USE_MATHJAX is set to YES.

MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@3

# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
Expand Down
79 changes: 49 additions & 30 deletions docs/DoxygenLayout.xml
View file
Original file line number Diff line number Diff line change
@@ -1,58 +1,76 @@
<?xml version="1.0" encoding="UTF-8"?>
<doxygenlayout version="1.0">
<!-- Generated by doxygen 1.9.8 -->
<!-- Manually edited -->

<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="user" visible="yes" url="@ref md_install" title="Install" />
<tab type="usergroup" visible="yes" url="@ref congruences_group" title="Congruences" >
<tab type="usergroup" visible="yes" url="group__congruences__group.html#nested-classes" title="Classes" >
<tab type="user" visible="yes" url="@ref libsemigroups::sims::const_rcgp_iterator" title="const_rcgp_iterator" />
<tab type="user" visible="yes" url="@ref libsemigroups::MinimalRepOrc" title="MinimalRepOrc" />
<tab type="user" visible="yes" url="@ref libsemigroups::RepOrc" title="RepOrc" />
<tab type="user" visible="yes" url="@ref libsemigroups::Sims1" title="Sims1" />
<tab type="user" visible="yes" url="@ref libsemigroups::Sims2" title="Sims2" />
<tab type="user" visible="yes" url="@ref libsemigroups::SimsSettings" title="SimsSettings" />
<tab type="user" visible="yes" url="@ref libsemigroups::SimsStats" title="SimsStats" />
</tab>
<!-- TODO: Figure out a way to avoid this hack -->
<tab type="user" visible="yes" url="group__congruences__group.html#func-members" title="Functions" />
</tab>
<tab type="examples" visible="yes" title="" intro=""/>
<tab type="user" visible="yes" url="@ref citelist" title="Bibliography" />
<tab type="user" url="https://github.com/libsemigroups/libsemigroups" title="GitHub"/>

<!--
<tab type="mainpage" visible="yes" title=""/>
<tab type="pages" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
<tab type="pages" visible="no" title="" intro=""/>
<tab type="namespaces" visible="no" title="">
<tab type="namespacelist" visible="no" title="" intro=""/>
<tab type="namespacemembers" visible="no" title="" intro=""/>
</tab>
<!-- <tab type="modules" visible="yes" title="" intro="">
<tab type="modulelist" visible="yes" title="" intro=""/>
<tab type="modulemembers" visible="yes" title="" intro=""/>
<tab type="modules" visible="no" title="" intro="">
<tab type="modulelist" visible="no" title="" intro=""/>
<tab type="modulemembers" visible="no" title="" intro=""/>
</tab>
<tab type="concepts" visible="yes" title="">
<tab type="concepts" visible="no" title="">
</tab>
<tab type="interfaces" visible="yes" title="">
<tab type="interfacelist" visible="yes" title="" intro=""/>
<tab type="interfaces" visible="no" title="">
<tab type="interfacelist" visible="no" title="" intro=""/>
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
<tab type="interfacehierarchy" visible="no" title="" intro=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="classlist" visible="yes" title="" intro=""/>
<tab type="classes" visible="no" title="">
<tab type="classlist" visible="no" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="yes" title="" intro=""/>
<tab type="classmembers" visible="yes" title="" intro=""/>
<tab type="hierarchy" visible="no" title="" intro=""/>
<tab type="classmembers" visible="no" title="" intro=""/>
</tab>
<tab type="structs" visible="yes" title="">
<tab type="structlist" visible="yes" title="" intro=""/>
<tab type="structs" visible="no" title="">
<tab type="structlist" visible="no" title="" intro=""/>
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
</tab>
<tab type="exceptions" visible="yes" title="">
<tab type="exceptionlist" visible="yes" title="" intro=""/>
<tab type="exceptions" visible="no" title="">
<tab type="exceptionlist" visible="no" title="" intro=""/>
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
<tab type="exceptionhierarchy" visible="no" title="" intro=""/>
</tab>
<tab type="examples" visible="yes" title="" intro=""/>
<!-- https://www.doxygen.nl/manual/customize.html#layout -->
<tab type="user" url="https://github.com/micro-os-plus/utils-lists-xpack" title="GitHub"/>

-->
</navindex>

<!-- Layout definition for a class page -->
<class>
<detaileddescription title=""/>
<briefdescription visible="yes"/>
<briefdescription visible="no"/>
<inheritancegraph visible="yes"/>
<memberdecl>
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<publicmethods title=""/>
<publicstaticmethods title=""/>
<!-- <services title=""/>
<!--
<services title=""/>
<interfaces title=""/>
<publicslots title=""/>
<signals title=""/>
Expand All @@ -79,8 +97,9 @@
<privatestaticattributes title=""/>
<friends title=""/>
<related title="" subtitle=""/>
<membergroups visible="yes"/>-->
</memberdecl> -->
<membergroups visible="yes"/>
-->
</memberdecl>
<memberdef>
<inlineclasses title=""/>
<typedefs title=""/>
Expand Down Expand Up @@ -180,7 +199,7 @@
<!-- Layout definition for a group page -->
<group>
<detaileddescription title=""/>
<!--<briefdescription visible="yes"/>-->
<!-- <briefdescription visible="yes"/> -->
<groupgraph visible="yes"/>
<memberdecl>
<nestedgroups visible="yes" title=""/>
Expand Down
14 changes: 14 additions & 0 deletions docs/custom.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#MSearchBox {
width: var(--searchbar-width);
}

.tabs #MSearchBox {
position: relative;
}

.github-corner svg {
fill: var(--primary-light-color);
color: var(--page-background-color);
width: 72px;
height: 72px;
}
Loading

0 comments on commit 3e59709

Please sign in to comment.