wip

eliaskosunen · Oct 28, 2023 · 6a3187c · 6a3187c
1 parent f60b640
commit 6a3187c
Show file tree

Hide file tree

Showing 41 changed files with 1,220 additions and 134 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,41 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+      - poxy
+    paths:
+      - "**.h"
+      - "**.hpp"
+      - "**.dox"
+      - "**.md"
+      - "docs/"
+      - "**/docs.yml"
+  workflow_dispatch:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Install dependencies
+        run: |
+          sudo apt -y update
+          sudo apt -y install --no-istall-recommends git python3 python3-pip doxygen
+          sudo -H pip3 install --upgrade poxy
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Generate docs
+        run: |
+          cd docs
+          poxy --verbose
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/html
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -153,7 +153,7 @@ set_interface_flags(scn_internal)
 add_subdirectory(scripts)
 
 add_subdirectory(benchmark)
-add_subdirectory(docs)
+#add_subdirectory(docs)
 add_subdirectory(examples)
 
 enable_testing()

diff --git a/docs/CMakeLists.txt → docs-old/CMakeLists.txt b/docs/CMakeLists.txt → docs-old/CMakeLists.txt
diff --git a/docs/Doxyfile.in → docs-old/Doxyfile.in b/docs/Doxyfile.in → docs-old/Doxyfile.in
diff --git a/docs/Pipfile → docs-old/Pipfile b/docs/Pipfile → docs-old/Pipfile
diff --git a/docs/Pipfile.lock → docs-old/Pipfile.lock b/docs/Pipfile.lock → docs-old/Pipfile.lock
diff --git a/docs/_static/css/custom.css → docs-old/_static/css/custom.css b/docs/_static/css/custom.css → docs-old/_static/css/custom.css
diff --git a/docs/api.rst → docs-old/api.rst b/docs/api.rst → docs-old/api.rst
diff --git a/docs/conf.py → docs-old/conf.py b/docs/conf.py → docs-old/conf.py
diff --git a/docs/guide.rst → docs-old/guide.rst b/docs/guide.rst → docs-old/guide.rst
@@ -97,7 +97,7 @@ so `--std=c++17` (or equivalent, or newer) needs to be included in the build fla
 Basic usage
 -----------
 
-``scn::scan`` can be used to parse various values from a source range.
+``scn::scan`` can be used to scan various values from a source range.
 
 A range is an object that has a beginning and an end.
 Examples of ranges are string literals, ``std::string`` and ``std::vector<char>``.

diff --git a/docs/index.rst → docs-old/index.rst b/docs/index.rst → docs-old/index.rst
diff --git a/docs/migration/migration_2_0.rst → docs-old/migration/migration_2_0.rst b/docs/migration/migration_2_0.rst → docs-old/migration/migration_2_0.rst
diff --git a/docs/requirements.txt → docs-old/requirements.txt b/docs/requirements.txt → docs-old/requirements.txt