Transition from Travis CI to GitHub Actions (chapter 5)

1. documentation.yml has been updated
2. doxygen_config has been updated

Author: jointpoints

.github/workflows/documentation.yml

@@ -1,32 +1,32 @@
-name: "Documentation"
+name: "Documentation update"
 
-# Controls when the action will run. Triggers the workflow on push or pull request
-# events but only for the master branch
+# Documentation is automatically updated after any push onto master branch
 on:
   push:
     branches: [ master ]
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   job:
-    name: "Docs"
+    name: "Documentation update"
     runs-on: ubuntu-latest
 
     steps:
+    # Duplicate the master branch to perform further actions independently
     - name: "Checkout code"
       uses: actions/checkout@v2.3.3
 
+    # Run Doxygen to update the documentation
     - name: "Run doxygen"
       uses: mattnotmitt/doxygen-action@v1.1.0
       with:
         working-directory: "."
         doxyfile-path: ./tools/doxygen_config
         enable-latex: true
 
-    - name: "Publish docs"
+    # Deploy updated documentation files onto gh-pages branch
+    - name: "Publish documentation"
       uses: peaceiris/actions-gh-pages@v3.6.4
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: "./tmp_docs"
+        publish_dir: "./docs"
         publish_branch: gh-pages
-

tools/doxygen_config

@@ -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           = "tms-nets"
+PROJECT_NAME           = "(t, m, s)-nets generator"
 
 # 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
@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # 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 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -829,7 +829,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = $(TRAVIS_BUILD_DIR)/include/tms-nets/niederreiter2.hpp   $(TRAVIS_BUILD_DIR)/include/tms-nets/details   $(TRAVIS_BUILD_DIR)/tools/main_page.md
+INPUT                  = ./include/tms-nets/niederreiter2.hpp   ./include/tms-nets/details   ./tools/main_page.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
@@ -981,7 +981,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 = $(TRAVIS_BUILD_DIR)/tools/main_page.md
+USE_MDFILE_AS_MAINPAGE = ./tools/main_page.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
@@ -1110,7 +1110,7 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = tmp_docs
+HTML_OUTPUT            = .
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).