From 4d0b32d08c64ab7ac31a0e51be819c04a81ea8c8 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 15 Sep 2020 18:48:48 -0400 Subject: [PATCH 1/5] moved doc -> docs --- {doc => docs}/Makefile | 0 {doc => docs}/aca_dark_current.rst | 0 {doc => docs}/aca_diagnostic_telemetry.rst | 0 {doc => docs}/aca_l0_telemetry.rst | 0 {doc => docs}/acq_stats.rst | 0 {doc => docs}/api.rst | 0 {doc => docs}/aspect_l1_products.rst | 0 {doc => docs}/aspect_vv.rst | 0 {doc => docs}/conf.py | 0 {doc => docs}/guide_stats.rst | 0 {doc => docs}/hdr3_only_msids.html | 0 {doc => docs}/index.rst | 0 {doc => docs}/make.bat | 0 {doc => docs}/observation_parameters.rst | 0 {doc => docs}/plots/aca_dark_warm_pix_frac.png | Bin {doc => docs}/plots/dac_vs_tempdiff.png | Bin {doc => docs}/plots/plot_cxctime_ccd_temp.png | Bin {doc => docs}/plots/slot_2.gif | Bin {doc => docs}/plots/tempccd_from_files.png | Bin {doc => docs}/plots/tempccd_from_get_slot_data.png | Bin {doc => docs}/starcheck.rst | 0 21 files changed, 0 insertions(+), 0 deletions(-) rename {doc => docs}/Makefile (100%) rename {doc => docs}/aca_dark_current.rst (100%) rename {doc => docs}/aca_diagnostic_telemetry.rst (100%) rename {doc => docs}/aca_l0_telemetry.rst (100%) rename {doc => docs}/acq_stats.rst (100%) rename {doc => docs}/api.rst (100%) rename {doc => docs}/aspect_l1_products.rst (100%) rename {doc => docs}/aspect_vv.rst (100%) rename {doc => docs}/conf.py (100%) rename {doc => docs}/guide_stats.rst (100%) rename {doc => docs}/hdr3_only_msids.html (100%) rename {doc => docs}/index.rst (100%) rename {doc => docs}/make.bat (100%) rename {doc => docs}/observation_parameters.rst (100%) rename {doc => docs}/plots/aca_dark_warm_pix_frac.png (100%) rename {doc => docs}/plots/dac_vs_tempdiff.png (100%) rename {doc => docs}/plots/plot_cxctime_ccd_temp.png (100%) rename {doc => docs}/plots/slot_2.gif (100%) rename {doc => docs}/plots/tempccd_from_files.png (100%) rename {doc => docs}/plots/tempccd_from_get_slot_data.png (100%) rename {doc => docs}/starcheck.rst (100%) diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/aca_dark_current.rst b/docs/aca_dark_current.rst similarity index 100% rename from doc/aca_dark_current.rst rename to docs/aca_dark_current.rst diff --git a/doc/aca_diagnostic_telemetry.rst b/docs/aca_diagnostic_telemetry.rst similarity index 100% rename from doc/aca_diagnostic_telemetry.rst rename to docs/aca_diagnostic_telemetry.rst diff --git a/doc/aca_l0_telemetry.rst b/docs/aca_l0_telemetry.rst similarity index 100% rename from doc/aca_l0_telemetry.rst rename to docs/aca_l0_telemetry.rst diff --git a/doc/acq_stats.rst b/docs/acq_stats.rst similarity index 100% rename from doc/acq_stats.rst rename to docs/acq_stats.rst diff --git a/doc/api.rst b/docs/api.rst similarity index 100% rename from doc/api.rst rename to docs/api.rst diff --git a/doc/aspect_l1_products.rst b/docs/aspect_l1_products.rst similarity index 100% rename from doc/aspect_l1_products.rst rename to docs/aspect_l1_products.rst diff --git a/doc/aspect_vv.rst b/docs/aspect_vv.rst similarity index 100% rename from doc/aspect_vv.rst rename to docs/aspect_vv.rst diff --git a/doc/conf.py b/docs/conf.py similarity index 100% rename from doc/conf.py rename to docs/conf.py diff --git a/doc/guide_stats.rst b/docs/guide_stats.rst similarity index 100% rename from doc/guide_stats.rst rename to docs/guide_stats.rst diff --git a/doc/hdr3_only_msids.html b/docs/hdr3_only_msids.html similarity index 100% rename from doc/hdr3_only_msids.html rename to docs/hdr3_only_msids.html diff --git a/doc/index.rst b/docs/index.rst similarity index 100% rename from doc/index.rst rename to docs/index.rst diff --git a/doc/make.bat b/docs/make.bat similarity index 100% rename from doc/make.bat rename to docs/make.bat diff --git a/doc/observation_parameters.rst b/docs/observation_parameters.rst similarity index 100% rename from doc/observation_parameters.rst rename to docs/observation_parameters.rst diff --git a/doc/plots/aca_dark_warm_pix_frac.png b/docs/plots/aca_dark_warm_pix_frac.png similarity index 100% rename from doc/plots/aca_dark_warm_pix_frac.png rename to docs/plots/aca_dark_warm_pix_frac.png diff --git a/doc/plots/dac_vs_tempdiff.png b/docs/plots/dac_vs_tempdiff.png similarity index 100% rename from doc/plots/dac_vs_tempdiff.png rename to docs/plots/dac_vs_tempdiff.png diff --git a/doc/plots/plot_cxctime_ccd_temp.png b/docs/plots/plot_cxctime_ccd_temp.png similarity index 100% rename from doc/plots/plot_cxctime_ccd_temp.png rename to docs/plots/plot_cxctime_ccd_temp.png diff --git a/doc/plots/slot_2.gif b/docs/plots/slot_2.gif similarity index 100% rename from doc/plots/slot_2.gif rename to docs/plots/slot_2.gif diff --git a/doc/plots/tempccd_from_files.png b/docs/plots/tempccd_from_files.png similarity index 100% rename from doc/plots/tempccd_from_files.png rename to docs/plots/tempccd_from_files.png diff --git a/doc/plots/tempccd_from_get_slot_data.png b/docs/plots/tempccd_from_get_slot_data.png similarity index 100% rename from doc/plots/tempccd_from_get_slot_data.png rename to docs/plots/tempccd_from_get_slot_data.png diff --git a/doc/starcheck.rst b/docs/starcheck.rst similarity index 100% rename from doc/starcheck.rst rename to docs/starcheck.rst From ccd19954bc26555882897040f1d76db08fd244f9 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 15 Sep 2020 18:58:14 -0400 Subject: [PATCH 2/5] using ska-theme --- docs/conf.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 45a262f1..dfed9fa6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -93,7 +93,12 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'bootstrap-ska' +html_theme_options = { +logotext1: 'Ska!' , +logotext2: 'mi', +logotext3: 'ca', +} # 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 From 8fbfc7e937fbab033ed90e31e613ce494ec755a2 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 15 Sep 2020 19:03:57 -0400 Subject: [PATCH 3/5] using ska-theme (fixup) --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index dfed9fa6..e27a3f04 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -95,9 +95,9 @@ # a list of builtin themes. html_theme = 'bootstrap-ska' html_theme_options = { -logotext1: 'Ska!' , -logotext2: 'mi', -logotext3: 'ca', + 'logotext1': 'Ska!' , + 'logotext2': 'mi', + 'logotext3': 'ca', } # Theme options are theme-specific and customize the look and feel of a theme From 1f65fb9b51a9433c79ba1e65896df7f5f8741b22 Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 22 Sep 2020 16:16:12 -0400 Subject: [PATCH 4/5] use the proper symbol for underlining the title --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index b369dcd8..8e503702 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,7 +23,7 @@ access to a comprehensive set of information related to Chandra aspect: starcheck API docs -======== +-------- .. toctree:: :maxdepth: 1 From 2d2113c3c3b85a0b1c408082df0e0677f749dbcc Mon Sep 17 00:00:00 2001 From: Javier Gonzalez Date: Tue, 22 Sep 2020 17:19:37 -0400 Subject: [PATCH 5/5] added link to tool_doc page on cxc --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index e27a3f04..1a775721 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -98,6 +98,9 @@ 'logotext1': 'Ska!' , 'logotext2': 'mi', 'logotext3': 'ca', + 'homepage_url': 'https://cxc.cfa.harvard.edu/mta/ASPECT/tool_doc', + 'homepage_text': 'ska', + 'homepage_text_2': 'tools' } # Theme options are theme-specific and customize the look and feel of a theme