From 66ece85b0e43c21e06863857be4e55abeeefd7ab Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Sun, 14 Aug 2022 16:23:52 -0400 Subject: [PATCH 1/4] :mag: Add table of contents to top of API reference page Make it easier to jump to the relevant sections, since the list of DataPipes is increasing! --- docs/api.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api.md b/docs/api.md index 62daa69..ef04dde 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,5 +1,9 @@ # API Reference +```{contents} +:local: +``` + ## DataPipes ```{eval-rst} From 926dd578dbddf7c122df068f21e287fe5399cea6 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Sun, 14 Aug 2022 16:25:48 -0400 Subject: [PATCH 2/4] :memo: Order DataPipe subsections on API page alphabetically Swapping positions of Pyogrio and Rioxarray datapipes. --- docs/api.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/api.md b/docs/api.md index ef04dde..bf8bdf5 100644 --- a/docs/api.md +++ b/docs/api.md @@ -22,21 +22,21 @@ :show-inheritance: ``` -### Rioxarray +### Pyogrio ```{eval-rst} -.. automodule:: zen3geo.datapipes.rioxarray -.. autoclass:: zen3geo.datapipes.RioXarrayReader -.. autoclass:: zen3geo.datapipes.rioxarray.RioXarrayReaderIterDataPipe +.. automodule:: zen3geo.datapipes.pyogrio +.. autoclass:: zen3geo.datapipes.PyogrioReader +.. autoclass:: zen3geo.datapipes.pyogrio.PyogrioReaderIterDataPipe :show-inheritance: ``` -### Pyogrio +### Rioxarray ```{eval-rst} -.. automodule:: zen3geo.datapipes.pyogrio -.. autoclass:: zen3geo.datapipes.PyogrioReader -.. autoclass:: zen3geo.datapipes.pyogrio.PyogrioReaderIterDataPipe +.. automodule:: zen3geo.datapipes.rioxarray +.. autoclass:: zen3geo.datapipes.RioXarrayReader +.. autoclass:: zen3geo.datapipes.rioxarray.RioXarrayReaderIterDataPipe :show-inheritance: ``` From d701a0c16cd970b042ffbeed6a7729f336ecc121 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Sun, 14 Aug 2022 16:29:26 -0400 Subject: [PATCH 3/4] :zap: Cache execution outputs when building jupyter book docs No need to build pages again if things haven't changed, see https://jupyterbook.org/en/latest/content/execute.html. --- docs/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index 0d422a9..e8e7d59 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -7,7 +7,7 @@ author: The zen3geo Team # Force re-execution of notebooks on each build. # See https://jupyterbook.org/content/execute.html execute: - execute_notebooks: force + execute_notebooks: cache # Define the name of the latex output file for PDF builds latex: From 81449ff2dd1e7a942ccb3141fd574336c939ce99 Mon Sep 17 00:00:00 2001 From: Wei Ji <23487320+weiji14@users.noreply.github.com> Date: Sun, 14 Aug 2022 16:46:42 -0400 Subject: [PATCH 4/4] :alien: Increase depth of secondary sidebar on the right from 2 to 3 Found the right sphinx-book-theme config setting to increase the depth of the secondary sidebar (on the right) from 2 to 3. See https://sphinx-book-theme.readthedocs.io/en/stable/customize/sidebar-secondary.html. Decided too that the in-page table of contents can go. --- docs/_config.yml | 3 +++ docs/api.md | 4 ---- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/_config.yml b/docs/_config.yml index e8e7d59..14f394b 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -31,6 +31,9 @@ sphinx: config: autodoc_typehints: 'description' html_show_copyright: false + html_theme_options: + # https://sphinx-book-theme.readthedocs.io/en/stable/customize/sidebar-secondary.html + show_toc_level: 3 intersphinx_mapping: datashader: - 'https://datashader.org/' diff --git a/docs/api.md b/docs/api.md index bf8bdf5..827291c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,9 +1,5 @@ # API Reference -```{contents} -:local: -``` - ## DataPipes ```{eval-rst}