Everest/charge som add git submodules

.github/workflows/linkcheck.yml

@@ -0,0 +1,28 @@
+name: Link check
+
+# Allow to trigger on pull requests and manually via Github Actions
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    # Use Ubuntu as environment
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository with submodules
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+        fetch-depth: 0
+
+    - name: Initialize and update submodules
+      run: git submodule update --init --recursive
+    # This external action cares about all the sphinx stuff
+    - name: Build project
+      uses: ammaraskar/[email protected]
+      with:
+        build-command: "sphinx-build -b linkcheck source/ build/"
+        docs-folder: "docs/"
+

.gitignore

@@ -0,0 +1,27 @@
+# Ignore node_modules directory
+node_modules/
+
+# Ignore build output
+dist/
+
+# Ignore IDE and editor files
+*~
+.vscode/
+.idea/
+
+# Ignore logs and temporary files
+*.log
+*.tmp
+
+# Ignore environment-specific files
+.env
+.env.local
+.env.development
+.env.production
+
+# Ignore sensitive or private information
+secrets.txt
+credentials.json
+
+# Ignore output folder for testing
+output/

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "includes"]
+	path = includes
+	url = https://github.com/chargebyte/chargebyte-docs.git
+	branch = shared-docs

.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: "2"
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+sphinx:
+  configuration: docs/source/conf.py
+
+submodules:
+  include: all #includes all git-submodules

README.rst

@@ -1,21 +1,68 @@
-chargebyte GmbH Product Documentation
-=============================
+Charge SOM Product Documentation
+================================
 
-Welcome to the documentation for products of chargebyte GmbH.
+This is the product documentation project for the Charge SOM, a product of chargebyte GmbH.
+This documentation is intended for users, developers, and administrators of the Charge SOM.
+This documentation is hosted on Read the Docs and can be accessed at
+https://chargebyte-docs.readthedocs.io/en/latest/.
 
-This documentation contains all necessary information and guides for the use and understanding of our products.
 
 Contents:
 ---------
 
-- Product specifc User Guides and Manuals (In Progress)
-- Developer Documentation (In Progress)
-- FAQs and Troubleshooting (In Progress)
+- Charge SOM User Guide
+
+Repo initialization:
+-------------------
+This repository is using git submodules to share documents between the user guides.
+After cloning of the project please execute the following command:
+
+git submodule update --init --force --remote
+
+
+Building the documentation locally:
+-----------------------------------
+
+To build the documentation locally, you need to have Python and pip installed on your system.
+You can install the required dependencies by running the following command:
+
+pip install -r requirements.txt
+
+After installing the dependencies, you can build the documentation by running the following command:
+
+sphinx-build -a docs/source {output_directory}
+
+The output directory is the directory where the generated HTML files will be stored.
+
+
+Contributing:
+-------------
+
+If you would like to contribute to the documentation, please fork the repository and create a pull
+request with your changes. Please make sure to follow the guidelines for contributing to the
+documentation:
+
+- The branch name for the pull request should be `everest/csom_{your_branch_name}`.
+- Maximum line length should be 120 characters (Preferably 100 characters).
+- Images should be stored in the `docs/source/_static/images` directory
+- CSS files should be stored in the `docs/source/_static/css` directory
+- Source and config files should be stored in the `docs/source/_static/files` directory
+- A documentation file should be written in reStructuredText format
+- A documentation file should start with referenceable label of the file name (e.g. ".. _hardware.rst:")
+- Sections and chapters should be separated by one blank line after the title and two blank lines before the title
+- Sections with a chapter title before, need to have only one blank line before the title
+- First letters of section and chapter titles should be capitalized (e.g. "Charge SOM User Guide")
+
+
+License:
+--------
+
+See the LICENSE file for license rights and limitations (Apache 2.0).
+
 
 Contact:
 --------
 
 If you have any questions or inquiries, please contact our support team at https://chargebyte.com/support.
 
 Thank you for using products from chargebyte GmbH!
-

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx==7.3.7
+sphinx-copybutton
+linuxdoc