started on hugo documentation

.github/workflows/pages.yml

@@ -0,0 +1,81 @@
+# Sample workflow for building and deploying a Hugo site to GitHub Pages
+name: Deploy Hugo site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.120.3
+    steps:
+      - name: Install Hugo CLI
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb          
+      # - name: Install Dart Sass
+      #   run: sudo snap install dart-sass
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+      - name: Install Node.js dependencies
+        run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
+      - name: Build with Hugo
+        env:
+          # For maximum backward compatibility with Hugo modules
+          HUGO_ENVIRONMENT: production
+          HUGO_ENV: production
+          TZ: America/Los_Angeles
+        run: |
+          hugo \
+            --gc \
+            --minify \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"          
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./public
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/themes/hugo-book"]
+	path = docs/themes/hugo-book
+	url = https://github.com/alex-shpak/hugo-book

README.md

@@ -2,20 +2,21 @@
 
 
 Fine-grained tracking of what goes into generated artifacts,
-and when do we actually need to recalculate them.
+and when it's necessary to recalculate them.
 
 Also, trivial parallelization.
 
 
+
 ## Description
 
 There's a bunch of 'pipeline' packages out there.
 
-For scientific workflow managment.
+For scientific workflow management.
 
 Often with a lot of 'magic'.
 
-SnakeMake is popular.
+SnakeMake for example is popular.
 
 Pypipegraph2 is a bit different.
 

content/faq/_index.md

@@ -0,0 +1,6 @@
++++
+title = "Frequently asked questions"
++++
+
+Guess we'll post theme here when we have them.
+

content/index.md

@@ -0,0 +1,41 @@
++++
+title = "PyPipegraph2 documentation"
++++
+
+Welcome to the PyPipegraph2 (ppg2) documentation.
+
+We strive for [Diátaxis](https://idratherbewriting.com/blog/what-is-diataxis-documentation-framework) in our documentation,
+therefore this documentation is structured into
+
+* [Tutorial](#tutorials)
+* [How-Tos](#how-tos)
+* [Reference](#reference)
+* [Explanations](#explanations)
+* [FAQ](./faq)
+
+
+
+## Tutorials
+
+* Minimal getting started
+* A larger example
+
+
+## How-Tos
+
+* Patterns for structuring job creations
+* Common 'gotchas'
+
+## Reference
+
+* Job classes
+* Managing Pypipegraphs
+* handy utilities
+
+
+## Explanations
+
+* Concepts and considerations
+
+
+

content/reference/_index.md

@@ -0,0 +1,25 @@
++++
+title = "Reference"
+weight:10
++++
+
+# Jobs
+
+
+## FileGeneratingJob
+
+
+## MultiFileGeneratingJob
+
+
+## TempFileGeneratingJob / MultiTempFileGeneratingJob
+
+# Managing pipegraphs 
+
+
+# handy utilities
+
+
+# external utilities
+
+

docs/archetypes/default.md

@@ -0,0 +1,5 @@
++++
+title = '{{ replace .File.ContentBaseName "-" " " | title }}'
+date = {{ .Date }}
+draft = true
++++