Merge pull request #36 from qir-alliance/feature/fixing-depandabot-issue

Alternative PR

Author: troelsfr

.github/workflows/cd-docs.yml

@@ -18,26 +18,27 @@ jobs:
             pkg-config \
             findutils \
             wget \
-            unzip doxygen        
+            unzip doxygen  texlive-font-utils
+     
+          pip install mkdocs
+          pip install mkdocs-gitbook
           wget https://github.com/matusnovak/doxybook2/releases/download/v1.3.6/doxybook2-linux-amd64-v1.3.6.zip
           unzip doxybook2-linux-amd64-v1.3.6.zip
 
       - name: Doxygen generation
         run: |
           doxygen doxygen.cfg
-          ./bin/doxybook2 --input Doxygen/xml --config docs/.doxybook/config.json --output docs/src/
-          rm -rf docs/src/Namespaces/namespace_0d*         
+          ./bin/doxybook2 --input Doxygen/xml --config docs/.doxybook/config.json --output docs/src/Api
 
       - name: Building docs
         run: |
           cd docs/
-          npm install
-          npm run build
+          mkdocs build
           cd ../
-          mv docs/src/.vuepress/dist ./build
+          mv docs/site ./
 
       - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@4.1.5
+        uses: JamesIves/github-pages-deploy-action@4.1.6
         with:
           branch: gh-pages
-          folder: build
+          folder: site

docs/.doxybook/config.json

@@ -1,7 +1,7 @@
 {
-  "baseUrl": "/",
+  "baseUrl": "/qat/Api/",
   "indexInFolders": true,
-  "linkLowercase": false,
+  "linkSuffix": "/",
   "indexClassesName": "index",
   "indexFilesName": "index",
   "indexGroupsName": "index",

docs/Dockerfile

@@ -0,0 +1,13 @@
+FROM python:2.7 as builder
+
+COPY ./ /src/
+WORKDIR /src/
+
+RUN pip install mkdocs
+RUN pip install mkdocs-gitbook
+RUN mkdocs build
+
+FROM nginx:latest as documentation
+ADD nginx/default.conf /etc/nginx/conf.d/default.conf
+
+COPY --from=builder /src/site /usr/share/nginx/html

docs/mkdocs.yml

@@ -0,0 +1,64 @@
+site_name: QAT Documentation
+site_url: https://qir-alliance.github.io/qat/
+base_url: /qat/
+docs_dir: src
+site_description: Everything you need to know about QAT API.
+site_author: troels
+extra_css: 
+  - css/quantum-colors.css
+markdown_extensions:
+  - admonition
+
+plugins:
+  - search
+
+theme:
+  name: null
+  custom_dir: "tailwind_theme/"
+  theme_dir: "tailwind_theme/"
+  static_templates:
+    - 404.html
+
+  include_search_page: false
+  search_index_only: false
+
+  highlightjs: true
+  hljs_languages: 
+    - bash
+    - cpp
+    - python
+    - llvm
+
+  hljs_style: "monokai-sublime"
+
+  navigation_depth: 2
+  nav_style: primary
+
+  shortcuts:
+    help: 191 # ?
+    next: 78 # n
+    previous: 80 # p
+    search: 83 # s
+
+nav:
+  - User guide:
+    - Quick start: "UserGuide/QuickStart.md"
+    - Building the library: "UserGuide/BuildingLibrary.md"
+    - Introduction to profiles: "UserGuide/IntroductionToProfiles.md"
+
+  - Developer guide:
+    - Architecture Overview: "DeveloperGuide/ArchitectureOverview.md"
+    - Writing a Component: "DeveloperGuide/WritingComponent.md"
+    - Configuration Library: "DeveloperGuide/ConfigurationLibrary.md"
+    - Rule based extensions: "DeveloperGuide/WritingRuleTests.md"
+
+  - Api:
+    - Classes: "Api/Classes/"
+    - Namespaces: "Api/Namespaces/" 
+    - Modules: "Api/Modules/"
+    - Files: "Api/Files/"
+    - Pages: "Api/Pages/"
+
+  - Contributing:
+    - Code quality: "DeveloperGuide/CodeQuality.md"
+    - Developer FAQ: "DeveloperGuide/DeveloperFAQ.md"

docs/package.json

@@ -0,0 +1 @@
+# API Documentation

docs/src/.vuepress/components/Foo/Bar.vue

@@ -109,7 +109,7 @@ This part defines pipelines for `.hpp` files and `.cpp` files allowing the devel
 
 Each of these CI stages can be executed individually using `./manage` or you can run the entire CI process by invoking `./manage runci`. An example of what this may look like is here:
 
-```zsh
+```sh
 ./manage runci
 
 2021-07-21 14:38:04,896 - FormatChecker - ERROR - /Users/tfr/Documents/Projects/qsharp-compiler/src/QsPasses/src/OpsCounter/OpsCounter.cpp was not correctly formatted.

docs/src/.vuepress/components/OtherComponent.vue

@@ -55,7 +55,7 @@ namespace SimpleLoop {
 
 The tool was ran with three options: `--apply`, `--profile base` and `-S`. First, it tells the tool to apply the profile to the QIR so that it can become a profile-specific QIR according to the profile selected. By specifying the value `baseProfile` to the argument `--profile`, we select which profile to use in the tool and the third argument ensures that LLVM IR will be printed to the terminal in a human readable format. The resulting code emitted (omitting declarations) is:
 
-```ll
+```llvm
 ; ModuleID = 'QSharpVersion/qir/Example.ll'
 source_filename = "QSharpVersion/qir/Example.ll"
 

docs/src/.vuepress/components/demo-component.vue

@@ -1,6 +1,6 @@
-# QIR profile documentation
+# QIR Adaptor Tool
 
-Welcome to the QIR Profile SDK, a framework to manipulate QIR into specific profiles. The goal of this framework is to create tools that allow quantum hardware vendors to adapt a generic QIR to their specific hardware profile.
+Welcome to the QIR Adapator Tool, a tool to manipulate QIR into specific profiles. The goal of this framework is to create tools that allow quantum hardware vendors to adapt a generic QIR to their specific hardware profile.
 
 User guide:
 

docs/src/.vuepress/config.js

@@ -0,0 +1,12 @@
+{% extends "base.html" %}
+
+{% block content %}
+
+    <div class="row-fluid">
+      <div id="main-content" class="span12">
+        <h1 id="404-page-not-found" style="text-align: center">404</h1>
+        <p style="text-align: center"><strong>Page not found</strong></p>
+      </div>
+    </div>
+
+{% endblock %}