Add root index.html so no need for crazy url for docs (#1871)

MatthijsBurgh · web-flow · commit ec374e992496 · 2021-04-18T10:23:02.000-04:00
diff --git a/.github/root_index.html b/.github/root_index.html
@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta http-equiv = "refresh" content = "0; url = web/html/doc/index.html" />
+    </head>
+    <body>
+    </body>
+</html>
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -269,16 +269,17 @@ jobs:
         cd ${{ github.workspace }}
         echo 'Generating Doxygen code documentation...'
         doxygen $DOXYFILE 2>&1 | tee doxygen.log
-        echo 'Creating .nojekyll and copying log...'
-        echo "" > doxygen/html/.nojekyll
-        cp doxygen.log doxygen/html/doxygen.log
         # Required so Doxygen links/finds the license file
         cp LICENSE doxygen/html/LICENSE
         # Required in order to link .github/media/ images with doc without modifying doc links. Remove if using `publish_dir: doxygen/html/`
         mkdir -p doxygen_final/web/html/ && mv doxygen/html doxygen_final/web/html/doc
         mkdir -p doxygen_final/web/.github/media/ && cp -rf .github/media/ doxygen_final/web/.github/
         mkdir -p doxygen_final/web/html/.github/media/ && cp -rf .github/media/ doxygen_final/web/html/.github/
         mkdir -p doxygen_final/web/html/doc/.github/media/ && cp -rf .github/media/ doxygen_final/web/html/doc/.github/
+        echo 'Copying log...'
+        cp doxygen.log doxygen_final/doxygen.log
+        echo 'Copying index.html to root pointing to actual docs'
+        cp .github/root_index.html doxygen_final/index.html
       if: ${{ matrix.DOCS }}
     - name: Deploy Docs
       uses: peaceiris/actions-gh-pages@v3

-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +<!DOCTYPE html>
 +<html>
 +    <head>
 +        <meta http-equiv = "refresh" content = "0; url = web/html/doc/index.html" />
 +    </head>
 +    <body>
 +    </body>
 +</html>