start the doc website (#400)

* add: mkdocs files for documentation * add: mkdocs files for documentation * change nav * change nav add external link * change nav add external link * feature: test pdf build * feature: test pdf build * feature: test pdf build 3 * Feature/doc (#401) * feature: test pdf build 3 * update build userguide * feature: allow for branches named doc * remove install requirmeents test * select branch doc * fix: allow add missing makefile for sphinx * add doc as a valid branch name * feature: add script to generate pdf * fix: rename link to parent page * Revert antares-deps and Antares_Simulator_Tests * fix: tidy up mkdocs and sphinx * fix: typo * Revert antares-deps * Remove duplicate src/changelog.mdown * Update to 8.1 Update by H. Antoine (RTE-i) * Try to fix 1-reference-guide.md * fix: latex errors md badly written Co-authored-by: Florian OMNES <[email protected]>
AntaresSimulatorTeam · Oct 13, 2021 · 91bcfa4 · 91bcfa4
1 parent 0754ccf
commit 91bcfa4
Show file tree

Hide file tree

Showing 30 changed files with 10,865 additions and 2,513 deletions.
diff --git a/.github/workflows/branchNameValidation.yml b/.github/workflows/branchNameValidation.yml
@@ -12,5 +12,5 @@ jobs:
     - uses: deepakputhraya/action-branch-name@master
       with:
         regex: '([a-z])+\/([a-z])+' # Regex the branch should match. This example enforces grouping
-        allowed_prefixes: 'feature,features,fix,release' # All branches should start with the given prefix
-        ignore: master,develop # Ignore exactly matching branch names from convention
+        allowed_prefixes: 'feature,features,fix,release,doc' # All branches should start with the given prefix
+        ignore: master,develop,doc # Ignore exactly matching branch names from convention
diff --git a/.github/workflows/build-userguide.yml b/.github/workflows/build-userguide.yml
@@ -0,0 +1,46 @@
+name: Build Userguide pdf
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+      - doc
+jobs:
+
+  build:
+
+    runs-on: ${{ matrix.os }}
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    strategy:
+      matrix:
+        os: [ubuntu-20.04]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Install dependencies
+      run: |
+          python -m pip install --upgrade pip
+          pip3 install -r requirements-doc.txt
+
+    - name: Install libraries
+      run: |
+           sudo apt-get update --fix-missing
+           sudo apt-get install latexmk texlive-latex-recommended texlive-formats-extra
+
+    - id: create-user-guide
+      name: user guide pdf creation
+      uses: ./.github/workflows/generate-userguide-pdf
+
+    - name: user guide upload
+      uses: actions/upload-artifact@v2
+      with:
+        name: ${{ steps.create-user-guide.outputs.pdf-name }}
+        path: ${{ steps.create-user-guide.outputs.pdf-path }}
+
diff --git a/.github/workflows/generate-userguide-pdf/action.yml b/.github/workflows/generate-userguide-pdf/action.yml
@@ -0,0 +1,22 @@
+name: "Generate User Guide pdf"
+description: "Generate User Guide pdf using Sphinx (not supported on windows)"
+outputs:
+  pdf-path:
+    description: "path of the user guide pdf"
+    value: ${{ steps.create.outputs.pdf-path }}
+  pdf-name:
+    description: "name of the user guide pdf"
+    value: ${{ steps.create.outputs.pdf-name }}
+runs:
+  using: "composite"
+  steps:
+    - id: create
+      shell: bash
+      run: |
+        PDF_NAME=antares-UserGuide.pdf
+        cd docs/pdf-doc-generation-with-sphinx
+        bash create_pdf_doc.sh $PDF_NAME
+        mv antaressimulatoruserguide.pdf $PDF_NAME
+        PDF_PATH=docs/pdf-doc-generation-with-sphinx/$PDF_NAME
+        echo "::set-output name=pdf-path::$PDF_PATH"
+        echo "::set-output name=pdf-name::$PDF_NAME"