Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

🔍 Show more levels for the in-page table of contents #36

Merged
merged 4 commits into from
Aug 14, 2022
Merged

🔍 Show more levels for the in-page table of contents #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
66ece85
:mag: Add table of contents to top of API reference page
weiji14 Aug 14, 2022
926dd57
:memo: Order DataPipe subsections on API page alphabetically
weiji14 Aug 14, 2022
d701a0c
:zap: Cache execution outputs when building jupyter book docs
weiji14 Aug 14, 2022
81449ff
:alien: Increase depth of secondary sidebar on the right from 2 to 3
weiji14 Aug 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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/'
Expand Down
16 changes: 8 additions & 8 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,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:
```

Expand Down