new doxygen

uleroboticsgroup · Nov 3, 2024 · f8f3035 · f8f3035
1 parent c057da6
commit f8f3035
Show file tree

Hide file tree

Showing 6 changed files with 196 additions and 44 deletions.
diff --git a/.github/Doxyfile-cpp b/.github/Doxyfile-cpp
@@ -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       = docs
+OUTPUT_DIRECTORY       = docs/yasmin_cpp
 
 # 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
@@ -485,7 +485,7 @@ NUM_PROC_THREADS       = 1
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.

diff --git a/.github/Doxyfile-python b/.github/Doxyfile-python
@@ -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       = docs
+OUTPUT_DIRECTORY       = docs/yasmin_python
 
 # 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
@@ -485,7 +485,7 @@ NUM_PROC_THREADS       = 1
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.

diff --git a/.github/workflows/doxygen-doc-cpp.yml b/.github/workflows/doxygen-doc-cpp.yml
diff --git a/.github/workflows/doxygen-doc-python.yml b/.github/workflows/doxygen-doc-python.yml
diff --git a/.github/workflows/doxygen-doc.yml b/.github/workflows/doxygen-doc.yml
@@ -0,0 +1,30 @@
+name: Generate and Deploy Doxygen for C++ and Python Code
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  doxygen_generation:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Generate Doxygen for C++
+        uses: mattnotmitt/doxygen-action@v1
+        with:
+          doxyfile-path: ".github/Doxyfile-cpp"
+
+      - name: Generate Doxygen for Python
+        uses: mattnotmitt/doxygen-action@v1
+        with:
+          doxyfile-path: ".github/Doxyfile-python"
+
+      - name: Deploy Doxygen page
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: docs
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,162 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>YASMIN Documentation</title>
+    <style>
+      /* Light theme variables */
+      :root {
+        --bg-color: #f8f8f8;
+        --text-color: #333;
+        --link-color: #004080;
+        --border-color: #cccccc;
+        --card-bg-color: #ffffff;
+        --card-shadow: rgba(0, 0, 0, 0.1);
+      }
+
+      /* Dark theme variables */
+      @media (prefers-color-scheme: dark) {
+        :root {
+          --bg-color: #1e1e1e;
+          --text-color: #e0e0e0;
+          --link-color: #5b9bd5;
+          --border-color: #444444;
+          --card-bg-color: #2a2a2a;
+          --card-shadow: rgba(255, 255, 255, 0.1);
+        }
+      }
+
+      /* General styles */
+      body {
+        font-family: Arial, sans-serif;
+        background-color: var(--bg-color);
+        color: var(--text-color);
+        margin: 0;
+        padding: 0;
+        transition: background-color 0.3s, color 0.3s;
+      }
+
+      header,
+      footer {
+        max-width: 800px;
+        margin: 20px auto;
+        padding: 20px;
+        background-color: var(--card-bg-color);
+        border: 1px solid var(--border-color);
+        border-radius: 4px;
+      }
+
+      header {
+        display: flex; /* Use flexbox for header layout */
+        align-items: center; /* Vertically center items */
+      }
+
+      header img {
+        max-width: 80px; /* Set a maximum width for the logo */
+        height: auto;
+        margin-right: 15px; /* Space between logo and title */
+      }
+
+      header a {
+        text-decoration: none; /* Remove underline from links */
+        color: var(--link-color); /* Link color */
+        display: flex; /* Allow children to flex */
+        align-items: center; /* Center items vertically */
+        width: 100%; /* Allow anchor to take full width */
+      }
+
+      header h1 {
+        font-size: 1.8em;
+        margin: 0; /* Remove default margin */
+        flex-grow: 1; /* Allow title to expand to fill space */
+      }
+
+      /* Documentation links container */
+      .doc-cards {
+        max-width: 800px;
+        margin: 0 auto;
+        padding: 0;
+        display: flex;
+        flex-direction: column;
+        gap: 20px; /* Increased gap between cards */
+      }
+
+      /* Doxygen-style boxes */
+      .doc-card {
+        display: block;
+        padding: 20px; /* Increased padding for comfort */
+        background-color: var(--card-bg-color);
+        border: 1px solid var(--border-color);
+        border-radius: 8px; /* More rounded corners */
+        box-shadow: 0 2px 4px var(--card-shadow); /* Subtle shadow */
+        transition: box-shadow 0.3s, transform 0.3s; /* Transition effects */
+        color: var(--text-color);
+        text-decoration: none;
+      }
+
+      .doc-card h2 {
+        font-size: 1.3em; /* Slightly larger title */
+        color: var(--link-color);
+        margin: 0 0 10px; /* Spacing below the title */
+      }
+
+      .doc-card p {
+        margin: 0;
+        color: var(--text-color);
+        font-size: 1em; /* Normalized font size */
+      }
+
+      /* Hover effect for the cards */
+      .doc-card:hover {
+        box-shadow: 0 4px 8px var(--card-shadow); /* Deeper shadow on hover */
+        transform: translateY(-2px); /* Lift effect on hover */
+      }
+
+      footer {
+        font-size: 0.8em;
+        text-align: center;
+        color: var(--text-color);
+      }
+
+      footer a {
+        color: var(--link-color);
+        text-decoration: none;
+      }
+
+      footer a:hover {
+        text-decoration: underline;
+      }
+    </style>
+  </head>
+  <body>
+    <header>
+      <a href="https://github.com/uleroboticsgroup/yasmin" target="_blank">
+        <img src="logo.png" alt="YASMIN Logo" />
+        <!-- Include the logo -->
+        <h1>YASMIN Documentation</h1>
+      </a>
+    </header>
+    <nav class="doc-cards">
+      <a href="yasmin_cpp/html/index.html" class="doc-card">
+        <h2>YASMIN C++ Documentation</h2>
+        <p>
+          Explore the comprehensive C++ library of YASMIN, featuring class
+          structures, function definitions, and usage examples.
+        </p>
+      </a>
+      <a href="yasmin_python/html/index.html" class="doc-card">
+        <h2>YASMIN Python Documentation</h2>
+        <p>
+          Discover the complete Python package of YASMIN, including module
+          overviews, function definitions, and practical examples.
+        </p>
+      </a>
+    </nav>
+    <footer>
+      <p>
+        Generated with <a href="https://www.doxygen.nl/index.html">Doxygen</a>
+      </p>
+    </footer>
+  </body>
+</html>