Enable Doxygen documentation

fdrmrc · Jan 7, 2024 · 58fbfbb · 58fbfbb
1 parent 76d4b0e
commit 58fbfbb
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 8 deletions.
diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml
@@ -17,12 +17,12 @@ jobs:
     - name: Build Doxygen documentation
       uses: mattnotmitt/[email protected]
       with:
-        doxyfile-path: "./docs/Doxyfile"
+        doxyfile-path: "./doc/Doxyfile"
         working-directory: "."
 
     - name: Publish Doxygen documentation
       uses: peaceiris/actions-gh-pages@v3
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./docs/html/
+        publish_dir: ./doc/html/
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -21,6 +21,6 @@ PROJECT(polydeal)
 ENABLE_TESTING()
 INCLUDE_DIRECTORIES(${CMAKE_SOURCE_DIR}/include)
 
-ADD_SUBDIRECTORY(src)
+ADD_SUBDIRECTORY(source)
 ADD_SUBDIRECTORY(examples)
 ADD_SUBDIRECTORY(test/polydeal)
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
 # Polygonal Discontinuous Galerkin (in deal.II)
 
-![GitHub CI](https://github.com/fdrmrc/AggloDeal/actions/workflows/tests.yml/badge.svg)
-![GitHub CI](https://github.com/fdrmrc/AggloDeal/actions/workflows/indentation.yml/badge.svg)
+[![GitHub CI](https://github.com/fdrmrc/Polydeal/actions/workflows/tests.yml/badge.svg)](https://github.com/fdrmrc/Polydeal/actions/workflows/tests.yml)
+[![Indent](https://github.com/fdrmrc/Polydeal/actions/workflows/indentation.yml/badge.svg)](https://github.com/fdrmrc/Polydeal/actions/workflows/indentation.yml)
+[![Doxygen](https://github.com/fdrmrc/Polydeal/actions/workflows/doxygen.yml/badge.svg)](https://github.com/fdrmrc/Polydeal/actions/workflows/doxygen.yml)
+
 
 ***PolyDEAL*** is an open source project in C++ which aims to provide building blocks for the implementation of Polygonal Discontinuous Galerkin methods, within the Finite Element library [**deal.II**](https://dealii.org).
 

diff --git a/docs/Doxyfile → doc/Doxyfile b/docs/Doxyfile → doc/Doxyfile
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "Template Deal.II Application"
+PROJECT_NAME           = "PolyDEAL"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
@@ -2202,14 +2202,14 @@ ALLEXTERNALS           = NO
 # listed.
 # The default value is: YES.
 
-EXTERNAL_GROUPS        = YES
+EXTERNAL_GROUPS        = NO
 
 # If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
 # the related pages index. If set to NO, only the current project's pages will
 # be listed.
 # The default value is: YES.
 
-EXTERNAL_PAGES         = YES
+EXTERNAL_PAGES         = NO
 
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool

diff --git a/src/CMakeLists.txt → source/CMakeLists.txt b/src/CMakeLists.txt → source/CMakeLists.txt
diff --git a/src/agglomeration_handler.cc → source/agglomeration_handler.cc b/src/agglomeration_handler.cc → source/agglomeration_handler.cc
diff --git a/src/assembly_check.cc → source/assembly_check.cc b/src/assembly_check.cc → source/assembly_check.cc
diff --git a/src/classical_dg_assembly.cc → source/classical_dg_assembly.cc b/src/classical_dg_assembly.cc → source/classical_dg_assembly.cc