Prepare the docs

.build.ci.sh

 #!/bin/bash
-# This is wrapper to run the build.sh on CI
+# This is wrapper to run the build.sh or build-xyz.sh on CI
+
+# The build mode is the suffix in build-xyz.sh
+export BUILD_CI_MODE=${1}
 
 echo "CEPCSW_LCG_RELEASE: ${CEPCSW_LCG_RELEASE}"
 echo "CEPCSW_LCG_PLATFORM: ${CEPCSW_LCG_PLATFORM}"
@@ -36,12 +39,26 @@ function build-with-log() {
 }
 
 function build-with-stdout() {
+    local build_flags=${BUILD_CI_MODE}
+    local source_flag=true
+
+    # Key4hep stack mode
     if [ "$CEPCSW_LCG_RELEASE" = "KEY4HEP_STACK" ]; then
-        ./build-k4.sh
-    else
+        build_flags=k4
+        source_flag=false
+    fi
+
+    # prepend '-' if necessary
+    if [ -n "$build_flags" ]; then
+       build_flags=-${build_flags}
+    fi
+
+    if $source_flag; then
         source setup.sh
-        ./build.sh
     fi
+    
+    ./build${build_flags}.sh
+
 }
 
 if [ -n "${GITHUB_ACTION}" ]; then

.gitlab-ci.yml

@@ -62,3 +62,16 @@ build:lcg:el7:
       - TDR_o1_v02.tgeo.root
     reports:
       junit: build.${CEPCSW_LCG_VERSION}.${CEPCSW_LCG_PLATFORM}/cepcsw-ctest-result.xml
+
+##############################################################################
+# Build the docs
+##############################################################################
+build:docs:
+  stage: build 
+  tags:
+    - centos7
+  script:
+    - bash ./.build.ci.sh docs
+  artifacts:
+    paths:
+      - docs/build/html/
\ No newline at end of file

.readthedocs.yaml

+version: "2"
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+sphinx:
+  configuration: docs/source/conf.py

build-docs.sh

+#!/bin/bash
+# Description:
+#   This script is used to build the CEPCSW docs.
+
+function check-sphinx() {
+    which sphinx-build >& /dev/null
+}
+
+function run-build-docs() {
+    pushd docs
+    make html
+    popd
+}
+
+if check-sphinx; then
+    run-build-docs
+else
+    echo "Please setup sphinx before build the docs. " 1>&2
+    exit -1
+fi

docs/Makefile

+# 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     = source
+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

+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

+sphinx==7.1.2
+sphinx-rtd-theme==1.3.0rc1
+myst-parser==2.0.0

docs/source/analysis/overview.md

+# Analysis tools
+
+Under construction.
\ No newline at end of file

docs/source/calo/overview.md

+# Calo
+
+Under construction.
\ No newline at end of file

docs/source/conf.py

+# Configuration file for the Sphinx documentation builder.
+
+# -- Project information
+
+project = 'CEPCSW Documentation'
+copyright = '2020-2024, CEPCSW'
+author = 'CEPCSW'
+
+release = 'tdr24.3'
+version = 'tdr24.3.1'
+
+# -- General configuration
+
+extensions = [
+    'sphinx.ext.duration',
+    'sphinx.ext.doctest',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.intersphinx',
+    'myst_parser'
+]
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+}
+intersphinx_disabled_domains = ['std']
+
+templates_path = ['_templates']
+
+# -- Options for HTML output
+
+html_theme = 'sphinx_rtd_theme'
+
+# -- Options for EPUB output
+epub_show_urls = 'footnote'

docs/source/data/overview.md

+# Data samples
+
+Under construction.
\ No newline at end of file

docs/source/dcomputing/overview.md

+# Distributed Computing
+
+Under construction.

docs/source/development/overview.md

+# Development Process Overview
+
+Under construction.
\ No newline at end of file

docs/source/framework/overview.md

+# Framework
+
+Under construction.
\ No newline at end of file

docs/source/generator/overview.md

+# Physics Generator
+
+Under construction.
\ No newline at end of file

docs/source/index.rst

+Welcome to CEPCSW Documentation
+===============================
+
+CEPCSW is built on top of Key4hep software stack. 
+
+.. note::
+
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Quickstart
+
+   quickstart/quickstart.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Development Process
+
+   development/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Framework
+
+   framework/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Generator
+
+   generator/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Simulation
+
+   simulation/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Tracking
+
+   tracking/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Calo
+
+   calo/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: PID
+
+   pid/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Analysis tools
+
+   analysis/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Data samples
+
+   data/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Distributed Computing
+
+   dcomputing/overview.md
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+   :caption: Release Notes
+
+   releasenotes/overview.md
+
+
+

docs/source/pid/overview.md

+# PID
+
+Under construction.
\ No newline at end of file

docs/source/quickstart/quickstart.md

+# Quickstart
+
+## Setup at IHEP cluster
+
+CEPCSW is already deployed at IHEP CVMFS. You can use it as following:
+
+```bash
+$ source /cvmfs/cepcsw.ihep.ac.cn/prototype/releases/tdr24.3.1/setup.sh
+$ gaudirun.py $DETCRDROOT/scripts/CRD_o1_v01-SimRec.py
+```

docs/source/releasenotes/overview.md

+# Release Notes
+
+Under construction. 
\ No newline at end of file

docs/source/simulation/overview.md

+# Simulation software
+
+Under construction.
\ No newline at end of file