doxy moved to docs folder

VeryAmazed · Mar 25, 2024 · 9192c3a · 9192c3a
1 parent 549b0fa
commit 9192c3a
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 108 deletions.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -31,6 +31,10 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+      - name: Doxygen Action
+        uses: mattnotmitt/doxygen-action@v1
+        with:
+          doxyfile-path: 'docs/Doxyfile'
       - name: Setup Pages
         uses: actions/configure-pages@v4
       - name: Upload artifact

diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,10 @@
 build
 .cache
 
+# doxygen output
+docs/html
+docs/latex
+
 # don't track subprojects
 subprojects/*
 # keep wrap files

diff --git a/Doxyfile → docs/Doxyfile b/Doxyfile → docs/Doxyfile
@@ -74,7 +74,7 @@ PROJECT_ICON           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = docs
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
 # sub-directories (in 2 levels) under the output directory of each output format
@@ -949,7 +949,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../include/digest
+INPUT                  = /include/digest
 
 # 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

diff --git a/docs/build.sh b/docs/build.sh
@@ -8,4 +8,4 @@ fi
 set -euo pipefail
 
 cd "${MESON_SOURCE_ROOT}"
-doxygen
+doxygen docs/Doxyfile
diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html
@@ -8,65 +8,7 @@
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 </head>
 <body>
-<a href="data__structure_8hpp_source.html"/>
-<a href="digester_8hpp_source.html"/>
-<a href="mod__minimizer_8hpp_source.html"/>
-<a href="syncmer_8hpp_source.html"/>
-<a href="thread__out_8hpp_source.html"/>
-<a href="window__minimizer_8hpp_source.html"/>
-<a href="classdigest_1_1BadConstructionException.html"/>
-<a href="classdigest_1_1BadConstructionException-members.html"/>
-<a href="classdigest_1_1BadModException.html"/>
-<a href="classdigest_1_1BadModException-members.html"/>
-<a href="classdigest_1_1BadWindowSizeException.html"/>
-<a href="classdigest_1_1BadWindowSizeException-members.html"/>
-<a href="classdigest_1_1Digester.html"/>
-<a href="classdigest_1_1Digester-members.html"/>
-<a href="classdigest_1_1ModMin.html"/>
-<a href="classdigest_1_1ModMin-members.html"/>
-<a href="classdigest_1_1NotRolledTillEndException.html"/>
-<a href="classdigest_1_1NotRolledTillEndException-members.html"/>
-<a href="classdigest_1_1Syncmer.html"/>
-<a href="classdigest_1_1Syncmer-members.html"/>
-<a href="classdigest_1_1WindowMin.html"/>
-<a href="classdigest_1_1WindowMin-members.html"/>
-<a href="structdigest_1_1ds_1_1Adaptive.html"/>
-<a href="structdigest_1_1ds_1_1Adaptive-members.html"/>
-<a href="structdigest_1_1ds_1_1Adaptive64.html"/>
-<a href="structdigest_1_1ds_1_1Adaptive64-members.html"/>
-<a href="structdigest_1_1ds_1_1Naive.html"/>
-<a href="structdigest_1_1ds_1_1Naive-members.html"/>
-<a href="structdigest_1_1ds_1_1Naive2.html"/>
-<a href="structdigest_1_1ds_1_1Naive2-members.html"/>
-<a href="structdigest_1_1ds_1_1SegmentTree.html"/>
-<a href="structdigest_1_1ds_1_1SegmentTree-members.html"/>
-<a href="classthread__out_1_1BadThreadOutParams.html"/>
-<a href="classthread__out_1_1BadThreadOutParams-members.html"/>
-<a href="dir_6d5a2e6e14cfb8a9edbe968d405e4bb3.html"/>
-<a href="dir_d44c64559bbebec7f509842c48db8b23.html"/>
 <a href="index.html"/>
 <a href="doxygen_crawl.html"/>
-<a href="annotated.html"/>
-<a href="classes.html"/>
-<a href="hierarchy.html"/>
-<a href="functions.html"/>
-<a href="functions.html"/>
-<a href="functions.html"/>
-<a href="functions.html"/>
-<a href="functions.html"/>
-<a href="functions.html"/>
-<a href="functions.html"/>
-<a href="functions.html"/>
-<a href="functions.html"/>
-<a href="functions_func.html"/>
-<a href="functions_func.html"/>
-<a href="functions_func.html"/>
-<a href="functions_func.html"/>
-<a href="functions_func.html"/>
-<a href="functions_func.html"/>
-<a href="functions_func.html"/>
-<a href="functions_func.html"/>
-<a href="functions_func.html"/>
-<a href="files.html"/>
 </body>
 </html>
diff --git a/docs/html/menudata.js b/docs/html/menudata.js
@@ -23,13 +23,4 @@
  @licend  The above is the entire license notice for the JavaScript code in this file
 */
 var menudata={children:[
-{text:"Main Page",url:"index.html"},
-{text:"Classes",url:"annotated.html",children:[
-{text:"Class List",url:"annotated.html"},
-{text:"Class Index",url:"classes.html"},
-{text:"Class Hierarchy",url:"hierarchy.html"},
-{text:"Class Members",url:"functions.html",children:[
-{text:"All",url:"functions.html"},
-{text:"Functions",url:"functions_func.html"}]}]},
-{text:"Files",url:"files.html",children:[
-{text:"File List",url:"files.html"}]}]}
+{text:"Main Page",url:"index.html"}]}
diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js
@@ -1,21 +1,12 @@
 var indexSectionsWithContent =
 {
-  0: "abdgimnrsw",
-  1: "abdmnsw",
-  2: "adgimnrsw"
 };
 
 var indexSectionNames =
 {
-  0: "all",
-  1: "classes",
-  2: "functions"
 };
 
 var indexSectionLabels =
 {
-  0: "All",
-  1: "Classes",
-  2: "Functions"
 };
 
diff --git a/docs/latex/refman.tex b/docs/latex/refman.tex
@@ -206,34 +206,6 @@
   % re-enable anchors again
   \hypersetup{pageanchor=true}
 %--- Begin generated contents ---
-\chapter{Hierarchical Index}
-\input{hierarchy}
-\chapter{Class Index}
-\input{annotated}
-\chapter{File Index}
-\input{files}
-\chapter{Class Documentation}
-\input{structdigest_1_1ds_1_1Adaptive}
-\input{structdigest_1_1ds_1_1Adaptive64}
-\input{classdigest_1_1BadConstructionException}
-\input{classdigest_1_1BadModException}
-\input{classthread__out_1_1BadThreadOutParams}
-\input{classdigest_1_1BadWindowSizeException}
-\input{classdigest_1_1Digester}
-\input{classdigest_1_1ModMin}
-\input{structdigest_1_1ds_1_1Naive}
-\input{structdigest_1_1ds_1_1Naive2}
-\input{classdigest_1_1NotRolledTillEndException}
-\input{structdigest_1_1ds_1_1SegmentTree}
-\input{classdigest_1_1Syncmer}
-\input{classdigest_1_1WindowMin}
-\chapter{File Documentation}
-\input{data__structure_8hpp_source}
-\input{digester_8hpp_source}
-\input{mod__minimizer_8hpp_source}
-\input{syncmer_8hpp_source}
-\input{thread__out_8hpp_source}
-\input{window__minimizer_8hpp_source}
 %--- End generated contents ---
 % Index
   \backmatter