Skip to content

Commit 1788c76

Browse files
FaHaGitFaHaGit
authored
Merge pull request #41 from chargebyte/everest/charge_som-add-git-submodules
Everest/charge SOM: Add git submodules
2 parents d70821c + fb3063c commit 1788c76

32 files changed

+10878
-8
lines changed

‎.github/workflows/linkcheck.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Link check
2+
3+
# Allow to trigger on pull requests and manually via Github Actions
4+
on:
5+
pull_request:
6+
workflow_dispatch:
7+
8+
jobs:
9+
build:
10+
# Use Ubuntu as environment
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repository with submodules
15+
uses: actions/checkout@v4
16+
with:
17+
submodules: recursive
18+
fetch-depth: 0
19+
20+
- name: Initialize and update submodules
21+
run: git submodule update --init --recursive
22+
# This external action cares about all the sphinx stuff
23+
- name: Build project
24+
uses: ammaraskar/[email protected]
25+
with:
26+
build-command: "sphinx-build -b linkcheck source/ build/"
27+
docs-folder: "docs/"
28+

‎.gitignore

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Ignore node_modules directory
2+
node_modules/
3+
4+
# Ignore build output
5+
dist/
6+
7+
# Ignore IDE and editor files
8+
*~
9+
.vscode/
10+
.idea/
11+
12+
# Ignore logs and temporary files
13+
*.log
14+
*.tmp
15+
16+
# Ignore environment-specific files
17+
.env
18+
.env.local
19+
.env.development
20+
.env.production
21+
22+
# Ignore sensitive or private information
23+
secrets.txt
24+
credentials.json
25+
26+
# Ignore output folder for testing
27+
output/

‎.gitmodules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule "includes"]
2+
path = includes
3+
url = https://github.com/chargebyte/chargebyte-docs.git
4+
branch = shared-docs

‎.readthedocs.yaml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
version: "2"
2+
3+
build:
4+
os: "ubuntu-22.04"
5+
tools:
6+
python: "3.10"
7+
8+
python:
9+
install:
10+
- requirements: docs/requirements.txt
11+
12+
sphinx:
13+
configuration: docs/source/conf.py
14+
15+
submodules:
16+
include: all #includes all git-submodules

‎README.rst

+55-8
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,68 @@
1-
chargebyte GmbH Product Documentation
2-
=============================
1+
Charge SOM Product Documentation
2+
================================
33

4-
Welcome to the documentation for products of chargebyte GmbH.
4+
This is the product documentation project for the Charge SOM, a product of chargebyte GmbH.
5+
This documentation is intended for users, developers, and administrators of the Charge SOM.
6+
This documentation is hosted on Read the Docs and can be accessed at
7+
https://chargebyte-docs.readthedocs.io/en/latest/.
58

6-
This documentation contains all necessary information and guides for the use and understanding of our products.
79

810
Contents:
911
---------
1012

11-
- Product specifc User Guides and Manuals (In Progress)
12-
- Developer Documentation (In Progress)
13-
- FAQs and Troubleshooting (In Progress)
13+
- Charge SOM User Guide
14+
15+
Repo initialization:
16+
-------------------
17+
This repository is using git submodules to share documents between the user guides.
18+
After cloning of the project please execute the following command:
19+
20+
git submodule update --init --force --remote
21+
22+
23+
Building the documentation locally:
24+
-----------------------------------
25+
26+
To build the documentation locally, you need to have Python and pip installed on your system.
27+
You can install the required dependencies by running the following command:
28+
29+
pip install -r requirements.txt
30+
31+
After installing the dependencies, you can build the documentation by running the following command:
32+
33+
sphinx-build -a docs/source {output_directory}
34+
35+
The output directory is the directory where the generated HTML files will be stored.
36+
37+
38+
Contributing:
39+
-------------
40+
41+
If you would like to contribute to the documentation, please fork the repository and create a pull
42+
request with your changes. Please make sure to follow the guidelines for contributing to the
43+
documentation:
44+
45+
- The branch name for the pull request should be `everest/csom_{your_branch_name}`.
46+
- Maximum line length should be 120 characters (Preferably 100 characters).
47+
- Images should be stored in the `docs/source/_static/images` directory
48+
- CSS files should be stored in the `docs/source/_static/css` directory
49+
- Source and config files should be stored in the `docs/source/_static/files` directory
50+
- A documentation file should be written in reStructuredText format
51+
- A documentation file should start with referenceable label of the file name (e.g. ".. _hardware.rst:")
52+
- Sections and chapters should be separated by one blank line after the title and two blank lines before the title
53+
- Sections with a chapter title before, need to have only one blank line before the title
54+
- First letters of section and chapter titles should be capitalized (e.g. "Charge SOM User Guide")
55+
56+
57+
License:
58+
--------
59+
60+
See the LICENSE file for license rights and limitations (Apache 2.0).
61+
1462

1563
Contact:
1664
--------
1765

1866
If you have any questions or inquiries, please contact our support team at https://chargebyte.com/support.
1967

2068
Thank you for using products from chargebyte GmbH!
21-

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/make.bat

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
12+
13+
%SPHINXBUILD% >NUL 2>NUL
14+
if errorlevel 9009 (
15+
echo.
16+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17+
echo.installed, then set the SPHINXBUILD environment variable to point
18+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
19+
echo.may add the Sphinx directory to PATH.
20+
echo.
21+
echo.If you don't have Sphinx installed, grab it from
22+
echo.https://www.sphinx-doc.org/
23+
exit /b 1
24+
)
25+
26+
if "%1" == "" goto help
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33+
34+
:end
35+
popd

‎docs/requirements.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx==7.3.7
2+
sphinx-copybutton
3+
linuxdoc

‎docs/source/_static/cb_logo.png

130 KB
Loading

0 commit comments

Comments
 (0)