Publish docs on GitHub pages

.github/workflows/deploy-gh-pages.yaml

@@ -0,0 +1,55 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy GitHub Pages with Sphinx-docs
+
+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 one concurrent deployment
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+      - name: Install Sphinx and plugins
+        run: |
+          pipx install sphinx
+          pipx inject sphinx recommonmark
+          pipx inject sphinx sphinx_rtd_theme
+      - name: Build docs with Sphinx-docs
+        working-directory: docs
+        run: make html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/build/
+
+  # 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@v2

.gitignore

@@ -60,3 +60,7 @@ docker-compose-prod-non-domain.yml
 docker-compose-prod.yml
 install-production.sh
 .gitlab-ci.yml
+
+# Sphinx documentation
+docs/_build/
+docs/build/

docs/source/about/meters.rst

@@ -16,19 +16,3 @@ date. ``Meter Details`` are meter specified details such as the
 manufacturer name, the serial number, assigned tariff, and its
 connection type. ``Meter transactions`` is a basic list that contains
 all transactions that hit the meter.
-
-## Targets By clicking on ``Targets`` in the sidebar will load a page
-with already set targets. The list shows only the key fields of each
-target. To see the details of a target, click on the ``Expand`` button.
-
-To add a **new Target** just click on the ``New Target`` on the right
-top side. After clicking on that button, a new page will be loaded.
-Firstly the manager/admin should assign a Cluster or a Mini-Grid (The
-difference is already explained
-`here <#Information-before-using-MPManager>`__). Then, the date until
-that target is valid should be selected.
-
-When these two steps are done; Its time to define our target with some
-fields like ``New connections``, ``Revenue per Month``,... None of these
-fields are marked as required. That means the manager/admin is free to
-enter or not to enter a value for each goal.

docs/source/about/targets.rst

@@ -18,4 +18,4 @@ Example: Cluster 1 has following Mini-Grids; MG-1 MG-2 and MG-3
 +-------------------+--------+--------+--------+
 
 The result of the cluster overview page would be 800 for expected new
-connections.
+connections.

docs/source/about/targets_sidebar.rst

@@ -0,0 +1,18 @@
+Targets (Sidebar)
+-----------------
+
+By clicking on ``Targets`` in the sidebar will load a page
+with already set targets. The list shows only the key fields of each
+target. To see the details of a target, click on the ``Expand`` button.
+
+To add a **new Target** just click on the ``New Target`` on the right
+top side. After clicking on that button, a new page will be loaded.
+Firstly the manager/admin should assign a Cluster or a Mini-Grid (The
+difference is already explained
+`here <#Information-before-using-MPManager>`__). Then, the date until
+that target is valid should be selected.
+
+When these two steps are done; Its time to define our target with some
+fields like ``New connections``, ``Revenue per Month``,... None of these
+fields are marked as required. That means the manager/admin is free to
+enter or not to enter a value for each goal.

docs/source/index.rst

@@ -1,6 +1,10 @@
 Welcome to the MPM Documentation
 ================================
 
+.. WARNING::
+   The MPM documentation is currently getting reworked. It might not be fully up-to-date.
+   Use this rendered documentation with caution.
+
 .. toctree::
     :maxdepth: 3
     :caption: About MPM
@@ -13,6 +17,7 @@ Welcome to the MPM Documentation
     about/minigriddashboard
     about/customers
     about/meters
+    about/targets_sidebar
     about/transactions
     about/tickets
     about/maintenance