v2.0 code

# 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)

# Configuration file for the Sphinx documentation builder.

#

# For the full list of built-in configuration values, see the documentation:

# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------

# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

import os

import sys

project = 'csst_cpic_sim'

copyright = '2023, CSST/CPIC Group'

author = 'CPIC Group'

release = '1.0.0'

# -- General configuration ---------------------------------------------------

# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [

    'sphinx.ext.autodoc',

    'sphinx.ext.napoleon',

    'sphinx.ext.doctest',

    'sphinx.ext.intersphinx',

    'sphinx.ext.todo',

    'sphinx.ext.coverage',

    'sphinx.ext.mathjax',

    'nbsphinx'

]

templates_path = ['_templates']

exclude_patterns = []

# -- Options for HTML output -------------------------------------------------

# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'sphinx_rtd_theme'

# html_static_path = ['_static']

CpicImgSim package

csst_cpic_sim package

==================

Submodules

----------

CpicImgSim.main module

csst_cpic_sim.main module

----------------------

.. automodule:: CpicImgSim.main

.. automodule:: csst_cpic_sim.main

   :members:

   :undoc-members:

   :show-inheritance:

CpicImgSim.target module

csst_cpic_sim.target module

------------------------

.. automodule:: CpicImgSim.target

.. automodule:: csst_cpic_sim.target

   :members:

   :undoc-members:

   :show-inheritance:

CpicImgSim.optics module

csst_cpic_sim.optics module

------------------------

.. automodule:: CpicImgSim.optics

.. automodule:: csst_cpic_sim.optics

   :members:

   :undoc-members:

   :show-inheritance:

CpicImgSim.camera module

csst_cpic_sim.camera module

------------------------

.. automodule:: CpicImgSim.camera

.. automodule:: csst_cpic_sim.camera

   :members:

   :undoc-members:

   :show-inheritance:

CpicImgSim.io module

csst_cpic_sim.io module

--------------------

.. automodule:: CpicImgSim.io

.. automodule:: csst_cpic_sim.io

   :members:

   :undoc-members:

   :show-inheritance:

CpicImgSim.config module

csst_cpic_sim.config module

------------------------

.. automodule:: CpicImgSim.config

.. automodule:: csst_cpic_sim.config

   :members:

   :undoc-members:

   :show-inheritance:

CpicImgSim.utils module

csst_cpic_sim.utils module

-----------------------

.. automodule:: CpicImgSim.utils

.. automodule:: csst_cpic_sim.utils

   :members:

   :undoc-members:

   :show-inheritance:

Module contents

---------------

.. automodule:: CpicImgSim

.. automodule:: csst_cpic_sim

   :members:

   :undoc-members:

   :show-inheritance: