Upload doc to Pages

kenneth-jia · kenneth-jia · commit 00e0acf3b977 · 2021-04-09T20:26:19.000+08:00
diff --git a/.github/workflows/kafka_api_gen_doc.yml b/.github/workflows/kafka_api_gen_doc.yml
@@ -11,8 +11,11 @@ jobs:
     runs-on: ubuntu-20.04
     env:
         BUILD_SUB_DIR: build/sub-build
+
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v2
+
       - name: Install Dependencies
         run: |
           mkdir -p $BUILD_SUB_DIR
@@ -34,16 +37,39 @@ jobs:
           cd $BUILD_SUB_DIR
           make VERBOSE=1
 
-      - name: Copy
+      - name: Collect
         run: |
-          mkdir doc-gen
-          cp $BUILD_SUB_DIR/doc/README.html doc-gen
-          cp -r $BUILD_SUB_DIR/doc/markdown doc-gen
-          cp -r $BUILD_SUB_DIR/doc/doxygen doc-gen
+          mkdir document
+          cp $BUILD_SUB_DIR/doc/index.html document
+          cp -r $BUILD_SUB_DIR/doc/markdown document
+          cp -r $BUILD_SUB_DIR/doc/doxygen document
 
-      - name: Upload
+      - name: Upload Artifact
         uses: actions/upload-artifact@v2
         with:
             name: document
-            path: doc-gen
+            path: document
+
+
+  kafka-api-deploy-doc:
+    needs: [kafka-api-build-doc]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.3.1
+        with:
+          persist-credentials: false
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v1
+        with:
+          name: document
+
+      #- name: Deploy to Pages
+      #  uses: JamesIves/github-pages-deploy-action@4.0.0
+      #  with:
+      #    #ssh-key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+      #    branch: gh-pages
+      #    folder: "document"
+      #    clean: true
 
diff --git a/README.md b/README.md
@@ -92,15 +92,19 @@ To make the life easier, we worked out the `Modern C++ based Kafka API`, -- a he
 
 ## Install
 
-    * The APIs is headers only
+* The APIs is headers only
 
-        * Just need to include the `include/kafka` directory in your project
+    * Just need to include the `include/kafka` directory in your project
 
-    * The compiler should support
+* The compiler should support
 
-        * Option 1: C++17
+    * Option 1: C++17
 
-        * Option 2: C++14, together with `boost` headers (would depend on `boost::optional` in the case)
+    * Option 2: C++14 (with pre-requirements)
+
+        * Need `boost` headers (for `boost::optional`)
+
+        * GCC only (with optimization, e.g. -O2)
 
 ## Start-up
 
diff --git a/scripts/markdown2html.py b/scripts/markdown2html.py
@@ -5,6 +5,7 @@
 import argparse
 import time
 import re
+from string import Template
 
 import markdown
 
@@ -14,22 +15,27 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <title>{title}</title>
-    <link href="https://stackpath.bootstrapcdn.com/bootswatch/4.4.1/slate/bootstrap.min.css" rel="stylesheet" integrity="sha384-G9YbB4o4U6WS4wCthMOpAeweY4gQJyyx0P3nZbEBHyz+AtNoeasfRChmek1C2iqV" crossorigin="anonymous">
+    <title>$title</title>
+    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.0/css/bootstrap.min.css" integrity="sha384-SI27wrMjH3ZZ89r4o+fGIJtnzkAnFs3E4qz9DIYioCQ5l9Rd/7UAa8DHcaL8jkWt" crossorigin="anonymous">
+    <style>
+      pre { background: #f5f5f5; border: 1px solid #ddd; border-radius: 4px; padding: 0.6em 1em; }
+      h1,h2 { margin-top: 1em; }
+      div.navbar { padding: 8px 0; }
+      div.toc { float: right; }
+    </style>
   </head>
   <body>
     <div class="container">
-      {html_content}
+      $html_content
       <hr/>
       <footer class="text-center text-muted">
-        Generated: {date}
+        Generated: $date
       </footer>
       <hr/>
     </div>
   </body>
 </html>'''
 
-
 extensions = ['toc', 'codehilite', 'meta', 'fenced_code', 'tables']
 extension_configs = {
     'toc' : [('anchorlink', True)],
@@ -51,18 +57,18 @@ def convert(infile, outdir):
             else:
                 md_content_lines.append(line)
     md_content = '\n'.join(md_content_lines)
-    
+
     title_found = re.compile("# *(.+)").findall(md_content)
     title = '' if not title_found else title_found[0]
-  
+
     html_content = md.convert(md_content)
-  
-    html_doc = html_template.format(date=time.strftime("%Y. %m. %d"), title=title, html_content=html_content)
+
+    html_doc = Template(html_template).substitute(date=time.strftime("%Y. %m. %d"), title=title, html_content=html_content)
 
     if not os.path.exists(outdir):
         os.makedirs(outdir)
 
-    outfile =  os.path.join(outdir, os.path.splitext(os.path.basename(infile))[0] + '.html')
+    outfile = os.path.join(outdir, 'index.html' if is_root_entry else (os.path.splitext(os.path.basename(infile))[0] + '.html'))
     with open(outfile, 'w') as html_file:
         html_file.write(html_doc)
 
@@ -72,9 +78,10 @@ def main():
     parser.add_argument("-i", "--in-files", nargs='+', help='<Required> Markdown files to convert', required=True)
     parser.add_argument("-o", "--out-dir", help='<Required> The directory to output converted html files', required=True)
     args = parser.parse_args()
-    
+
     for in_file in args.in_files:
         convert(in_file, args.out_dir)
 
 if __name__ == "__main__":
-  main()
+    main()
+
