From 00df71291e0f4f0f82d49f45ed6b1aa90e40a4bc Mon Sep 17 00:00:00 2001 From: Kris Stern Date: Fri, 15 Feb 2019 10:20:04 +0800 Subject: [PATCH 1/7] Updating "Page Contents" in sidebar --- docs/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index f9ac6c76..b348f4d5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,16 +15,19 @@ Documentation The documentation for this package is here: .. toctree:: + :collapse: False :maxdepth: 2 ccdproc/install.rst .. toctree:: + :collapse: False :maxdepth: 3 ccdproc/index.rst .. toctree:: + :collapse: False :maxdepth: 1 authors_for_sphinx From 40b6ee5748766f6f1dc2409d5314dca9d87e62e0 Mon Sep 17 00:00:00 2001 From: Kris Stern Date: Fri, 15 Feb 2019 10:26:06 +0800 Subject: [PATCH 2/7] Added name to AUTHORS.rst --- AUTHORS.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/AUTHORS.rst b/AUTHORS.rst index 8acfef9b..67ecb23e 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -41,6 +41,7 @@ Alphabetical list of contributors * William Schoenell (@wschoenell) * Sourav Singh (@souravsingh) * Brigitta Sipocz (@bsipocz) +* Kris Stern (@kakirastern) * Connor Stotts (@stottsco) * Ole Streicher (@olebole) * JVSN Reddy (@janga1997) From 9910e5553c8909f87efdab3e96d5afb5307e6d8b Mon Sep 17 00:00:00 2001 From: Kris Stern Date: Fri, 15 Feb 2019 10:55:20 +0800 Subject: [PATCH 3/7] Minor editing of index.rst To remove illegal `toctree` option `collapse`. --- docs/index.rst | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index b348f4d5..a47ba652 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,31 +3,28 @@ CCDPROC ================ -Welcome to the ccdproc documentation! Ccdproc is is an affiliated package for -the AstroPy package for basic data reductions of CCD images. The ccdproc +Welcome to the ccdproc documentation! Ccdproc is is an Astropy-affiliated +package for basic data reductions of CCD images. The ccdproc package provides many of the necessary tools for processing of ccd images built -on a framework to provide error propagation and bad pixel tracking throughout +on a framework which provides error propagation and bad pixel tracking throughout the reduction process. Documentation ============= -The documentation for this package is here: +The documentation for this package is as follows: .. toctree:: - :collapse: False :maxdepth: 2 ccdproc/install.rst .. toctree:: - :collapse: False :maxdepth: 3 ccdproc/index.rst .. toctree:: - :collapse: False :maxdepth: 1 authors_for_sphinx From 70facc6e8fdb731618d11333e24069cbc1c4d0bc Mon Sep 17 00:00:00 2001 From: Kris Stern Date: Fri, 15 Feb 2019 11:02:51 +0800 Subject: [PATCH 4/7] Updating "conf.py" file to try and suppress collapsing of navigation --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index f4dda48f..60fd992c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -111,6 +111,7 @@ 'logotext1': 'ccd', # white, semi-bold 'logotext2': 'proc', # orange, light 'logotext3': ':docs' # white, light + "collapse_navigation" : False } From f3cdb68338ec41d7250a2ddd2272863b4f027c3f Mon Sep 17 00:00:00 2001 From: Kris Stern Date: Fri, 15 Feb 2019 11:39:57 +0800 Subject: [PATCH 5/7] Testing some "html_theme_options" in "conf.py" file --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 60fd992c..e24dcd48 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -111,7 +111,8 @@ 'logotext1': 'ccd', # white, semi-bold 'logotext2': 'proc', # orange, light 'logotext3': ':docs' # white, light - "collapse_navigation" : False + 'navigation_depth': 3, # Testing this + 'collapse_navigation': False # Testing this } From b0a17a3bcd70a9e222a5ec10c8016cff318da90c Mon Sep 17 00:00:00 2001 From: Kris Stern Date: Fri, 15 Feb 2019 11:48:47 +0800 Subject: [PATCH 6/7] Undoing the experimentation code snippets added earlier --- docs/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e24dcd48..f4dda48f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -111,8 +111,6 @@ 'logotext1': 'ccd', # white, semi-bold 'logotext2': 'proc', # orange, light 'logotext3': ':docs' # white, light - 'navigation_depth': 3, # Testing this - 'collapse_navigation': False # Testing this } From 4ca03aff0dd6d62169d855f9d9fc35443530bf12 Mon Sep 17 00:00:00 2001 From: Kris Stern Date: Fri, 15 Feb 2019 11:50:41 +0800 Subject: [PATCH 7/7] Experimenting with toctree option "includehidden" --- docs/index.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index a47ba652..39ed6359 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,16 +15,19 @@ Documentation The documentation for this package is as follows: .. toctree:: + :includehidden: :maxdepth: 2 ccdproc/install.rst .. toctree:: + :includehidden: :maxdepth: 3 ccdproc/index.rst .. toctree:: + :includehidden: :maxdepth: 1 authors_for_sphinx