소스 검색

:octocat: build local RTD manual

smiley 2 년 전
부모
커밋
2c870d58fc
1개의 변경된 파일53개의 추가작업 그리고 28개의 파일을 삭제
  1. 53 28
      .github/workflows/ci.yml

+ 53 - 28
.github/workflows/ci.yml

@@ -50,34 +50,6 @@ jobs:
         run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
         run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
 
 
 
 
-  build-docs:
-    name: "Build and publish Docs"
-    if: github.ref_name == 'main'
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: "Checkout sources"
-        uses: actions/checkout@v3
-
-      - name: "Install PHP"
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: "8.1"
-          coverage: none
-          tools: phpDocumentor
-          extensions: fileinfo, gd, imagick, json, mbstring
-
-      - name: "Build Docs"
-        run: phpdoc --config=phpdoc.xml.dist
-
-      - name: "Publish Docs to gh-pages"
-        uses: JamesIves/github-pages-deploy-action@v4
-        with:
-          branch: gh-pages
-          folder: .build/phpdocs
-          clean: true
-
-
   tests:
   tests:
     name: "Unit Tests"
     name: "Unit Tests"
     needs: static-code-analysis
     needs: static-code-analysis
@@ -124,3 +96,56 @@ jobs:
         with:
         with:
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
           project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
           coverage-reports: .build/coverage/clover.xml
           coverage-reports: .build/coverage/clover.xml
+
+
+  build-docs:
+    name: "Build and publish API docs"
+    if: github.ref_name == 'main'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: "Checkout sources"
+        uses: actions/checkout@v3
+
+      - name: "Install PHP"
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.1"
+          coverage: none
+          tools: phpDocumentor
+          extensions: fileinfo, gd, imagick, json, mbstring
+
+      - name: "Build API docs"
+        run: phpdoc --config=phpdoc.xml.dist
+
+      - name: "Publish API docs to branch gh-pages"
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: .build/phpdocs
+          clean: true
+
+
+  build-manual:
+    name: "Build and publish user manual"
+    if: github.ref_name == 'main'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: "Checkout sources"
+        uses: actions/checkout@v3
+
+      - name: "Install Sphinx"
+        run: pip install sphinx myst-parser sphinx-rtd-theme
+
+      - name: "Build manual"
+        run: |
+          cd docs
+          make
+
+      - name: "Publish user manual to branch readthedocs"
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: readthedocs
+          folder: .build/sphinx/html
+          clean: true