doc(refactor): move static docs out of repo to be built automatically

.github/workflows/build_and_publish_docs.yml

@@ -0,0 +1,47 @@
+name: Build and Publish Documentation (Pushes)
+
+on:
+  push:
+    branches: [main]
+  release:
+    types: [published]
+
+jobs:
+  build-and-deploy-docs:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.11"
+
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install doxygen
+          pip install -r doc/requirements.txt
+
+      - name: Checkout main branch
+        continue-on-error: true
+        run: git checkout --track origin/main
+
+      - name: Build Documentation
+        run: |
+          cd doc
+          # ignore if the following command fails
+          build-docs -t esp32 -l en --project-path ../ --source-dir ./ --doxyfile_dir ./ || true
+          cp -r _build/en/esp32/html/* ../docs/.
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs
+          force_orphan: true

README.md

@@ -1,11 +1,27 @@
 # Espressif++ (ESPP)
 
-This is the repository for some c++ components developed for the [ESP-IDF](https://github.com/espressif/esp-idf) farmework.
+This is the repository for some c++ components developed for the
+[ESP-IDF](https://github.com/espressif/esp-idf) framework.
 
- * [Documentation](https://esp-cpp.github.io/espp/) - github hosted version of the documentation found in [./docs](./docs), which is built by running [./build_docs.sh](./build_docs.sh). NOTE: to ensure proper build environments, the documentation build now relies on docker, so you'll need to run `docker build -t esp-docs doc` once before running `build_docs.sh`.
+ * [Documentation](https://esp-cpp.github.io/espp/) - github hosted version of
+   the documentation found in [./docs](./docs). This documentation is
+   automatically built as part of the CI, but can be locally built for
+   validation by running [./build_docs.sh](./build_docs.sh). NOTE: to ensure
+   proper build environments, the local documentation build relies on docker, so
+   you'll need to run `docker build -t esp-docs doc` once before running
+   `build_docs.sh`. This is only required if you want to build the documentation
+   locally.
 
-Many components in this repo contain example code (referenced in the documentation above) that shows some basic usage. This example code can be found in that component's `example` directory. NOTE: many component examples also make use of other components (esp. some of the foundational components such as `format`, `logger`, and `task`.
+Many components in this repo contain example code (referenced in the
+documentation above) that shows some basic usage. This example code can be found
+in that component's `example` directory. NOTE: many component examples also make
+use of other components (esp. some of the foundational components such as
+`format`, `logger`, and `task`.
 
-The [esp-cpp github organization](https://github.com/esp-cpp) contains other repositories that build specific demonstrations with these (and other) components.
+The [esp-cpp github organization](https://github.com/esp-cpp) contains other
+repositories that build specific demonstrations with these (and other)
+components.
 
-One such example is the [esp-box-emu](http://github.com/esp-cpp/esp-box-emu) repository, which builds upon these components to create a multiplatform emulation system using the ESP32-S3-BOX hardware.
+One such example is the [esp-box-emu](http://github.com/esp-cpp/esp-box-emu)
+repository, which builds upon these components to create a multiplatform
+emulation system using the ESP32-S3-BOX hardware.