From 0d33eb516fe958fac27d24ea163e92675d485533 Mon Sep 17 00:00:00 2001 From: shoulinwei Date: Thu, 10 Jun 2021 21:19:36 +0800 Subject: [PATCH] docs --- docs/source/conf.py | 2 +- docs/source/index.rst | 28 +++---------------- docs/{ => source}/rst/csst_dfs_api.common.rst | 0 docs/{ => source}/rst/csst_dfs_api.cpic.rst | 0 .../rst/csst_dfs_api.facility.rst | 0 docs/{ => source}/rst/csst_dfs_api.hstdm.rst | 0 docs/{ => source}/rst/csst_dfs_api.ifs.rst | 0 docs/{ => source}/rst/csst_dfs_api.mci.rst | 0 docs/{ => source}/rst/csst_dfs_api.msc.rst | 0 docs/{ => source}/rst/csst_dfs_api.rst | 0 docs/{ => source}/rst/modules.rst | 0 11 files changed, 5 insertions(+), 25 deletions(-) rename docs/{ => source}/rst/csst_dfs_api.common.rst (100%) rename docs/{ => source}/rst/csst_dfs_api.cpic.rst (100%) rename docs/{ => source}/rst/csst_dfs_api.facility.rst (100%) rename docs/{ => source}/rst/csst_dfs_api.hstdm.rst (100%) rename docs/{ => source}/rst/csst_dfs_api.ifs.rst (100%) rename docs/{ => source}/rst/csst_dfs_api.mci.rst (100%) rename docs/{ => source}/rst/csst_dfs_api.msc.rst (100%) rename docs/{ => source}/rst/csst_dfs_api.rst (100%) rename docs/{ => source}/rst/modules.rst (100%) diff --git a/docs/source/conf.py b/docs/source/conf.py index da4d75e..046201f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -81,7 +81,7 @@ pygments_style = None # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'classic' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/source/index.rst b/docs/source/index.rst index dfe494e..ec97e2c 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -28,32 +28,12 @@ This library can be installed with the following command: pip install -r requirements.txt python setup.py install -Documentation for the Code -************************** -.. toctree:: - :maxdepth: 2 - :caption: Contents: - -Common +APIs ===================== -.. automodule:: csst_dfs_api.common - :members: - -Facility -======================= -.. automodule:: csst_dfs_api.facility - :members: - -MSC -======================= -.. automodule:: csst_dfs_api.msc - :members: - -IFS -======================= -.. automodule:: csst_dfs_api.ifs - :members: +.. toctree:: + :maxdepth: 4 + rst/modules Indices and tables ================== diff --git a/docs/rst/csst_dfs_api.common.rst b/docs/source/rst/csst_dfs_api.common.rst similarity index 100% rename from docs/rst/csst_dfs_api.common.rst rename to docs/source/rst/csst_dfs_api.common.rst diff --git a/docs/rst/csst_dfs_api.cpic.rst b/docs/source/rst/csst_dfs_api.cpic.rst similarity index 100% rename from docs/rst/csst_dfs_api.cpic.rst rename to docs/source/rst/csst_dfs_api.cpic.rst diff --git a/docs/rst/csst_dfs_api.facility.rst b/docs/source/rst/csst_dfs_api.facility.rst similarity index 100% rename from docs/rst/csst_dfs_api.facility.rst rename to docs/source/rst/csst_dfs_api.facility.rst diff --git a/docs/rst/csst_dfs_api.hstdm.rst b/docs/source/rst/csst_dfs_api.hstdm.rst similarity index 100% rename from docs/rst/csst_dfs_api.hstdm.rst rename to docs/source/rst/csst_dfs_api.hstdm.rst diff --git a/docs/rst/csst_dfs_api.ifs.rst b/docs/source/rst/csst_dfs_api.ifs.rst similarity index 100% rename from docs/rst/csst_dfs_api.ifs.rst rename to docs/source/rst/csst_dfs_api.ifs.rst diff --git a/docs/rst/csst_dfs_api.mci.rst b/docs/source/rst/csst_dfs_api.mci.rst similarity index 100% rename from docs/rst/csst_dfs_api.mci.rst rename to docs/source/rst/csst_dfs_api.mci.rst diff --git a/docs/rst/csst_dfs_api.msc.rst b/docs/source/rst/csst_dfs_api.msc.rst similarity index 100% rename from docs/rst/csst_dfs_api.msc.rst rename to docs/source/rst/csst_dfs_api.msc.rst diff --git a/docs/rst/csst_dfs_api.rst b/docs/source/rst/csst_dfs_api.rst similarity index 100% rename from docs/rst/csst_dfs_api.rst rename to docs/source/rst/csst_dfs_api.rst diff --git a/docs/rst/modules.rst b/docs/source/rst/modules.rst similarity index 100% rename from docs/rst/modules.rst rename to docs/source/rst/modules.rst -- GitLab