Add Sphinx documentation

[markccchiang]

Description

In response to @kswang1029’s question about the ICD tests documentation, I created a Sphinx document and reformatted it in this style. Sphinx supports themes such as ReadtheDocs and PlantUML integration, and it can generate output in formats including HTML, PDF, ePub, and LaTeX from the same source. It can also be installed easily when using a Python environment manager such as Miniconda.

Step-by-step: Installing and Creating a Sphinx Document with Miniconda

0. Create a new Miniconda environment (example):

conda create -n py312 python=3.12
conda activate py312

1. Install Sphinx and extensions (including PlantUML):

conda install sphinx
conda install sphinx_rtd_theme
conda install plantuml
conda install sphinxcontrib-plantuml

2. Clone this GitHub branch:

git clone -b mark/create_sphinx_docs https://github.com/CARTAvis/ICD-RxJS.git

3. Build the Sphinx documentation in HTML format:

cd ICD-RxJS/docs
make html

4. Open the generated HTML document:

macOS:

open build/html/index.html

Linux:

xdg-open build/html/index.html

The generated documentation is available here. If this documentation style is acceptable to everyone, I will migrate the remaining ICD test documents from Google Docs to this format in a separate PR. Once finalized, I will also add this link to the CARTA GitHub page under Developer documentation.

Checklist

For the pull request:

• The Document unchange / Need update the Document