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.

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

Use MyST-NB to render jupyter notebook and markdown files #196

Merged
merged 54 commits into from
Dec 21, 2021
Merged
Show file tree
Hide file tree
Changes from 53 commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
936d64f
Use MyST-NB to render jupyter notebook and markdown files
weiji14 Apr 9, 2021
5b62759
Make code of conduct link show up on sidebar
weiji14 Apr 9, 2021
b61a057
Remove unused layout template
weiji14 Apr 9, 2021
142b94c
Use Sphinx's built-in Napolean extension instead of numpydoc
weiji14 Apr 9, 2021
7998f7d
Fix API docs links by putting .rst first in sphinx conf.py
weiji14 Apr 9, 2021
6bcb7c1
Exclude dev-notebooks folder and turn off MyST jupyter notebook execu…
weiji14 Apr 9, 2021
7da1e95
Move DAAC DataAccess example to doc/source/example_notebooks
weiji14 Apr 9, 2021
6e1e22b
Add linkify MyST extension to convert bare URLs to actual hyperlinks
weiji14 Apr 9, 2021
3f5c527
Automatically create targets for section headers
weiji14 Apr 9, 2021
d63119e
Sort requirements-docs.txt alphabetically
weiji14 Apr 9, 2021
67c213e
Move Data Visualization example to doc/source/example_notebooks
weiji14 May 24, 2021
1f547e3
migrate rest of examples and add to docs
JessicaS11 Oct 5, 2021
335fcef
populate examples readme for GitHub findability of examples
JessicaS11 Oct 5, 2021
82c4b18
update examples to eval an rst file
JessicaS11 Oct 5, 2021
600cc7c
use toc tree directive
JessicaS11 Oct 5, 2021
17080db
add rst eval directive to toctree directive
JessicaS11 Oct 5, 2021
1453dce
fix typos in docs identified by warnings
JessicaS11 Oct 5, 2021
1be21a0
try relocating notebook now that rednering is happening
JessicaS11 Oct 6, 2021
e6a1555
fix DEM example filename
JessicaS11 Oct 6, 2021
eca6851
revert to numpydoc instead of built-in Sphinx napoleon
JessicaS11 Oct 6, 2021
9bec2ae
reduce toc depth for examples
JessicaS11 Oct 6, 2021
1703a0e
try re-adding example link
JessicaS11 Oct 6, 2021
c7e9916
try re-adding example link
JessicaS11 Oct 6, 2021
efb4a64
remove dev notebooks
JessicaS11 Dec 14, 2021
2a6299b
move all example notebooks into doc after rebase
JessicaS11 Dec 14, 2021
b1f1b80
remove dev-notebooks from exclusion list since dir was removed
JessicaS11 Dec 14, 2021
841be70
revert code of conduct link to rst
JessicaS11 Dec 14, 2021
663b477
fix file to previous syntax
JessicaS11 Dec 14, 2021
f5dc0e5
add examples.rst from dev branch to retain git tracking with edits
JessicaS11 Dec 14, 2021
a7aebca
update and move examples.rst
JessicaS11 Dec 14, 2021
b47f44c
remove example link rst
JessicaS11 Dec 14, 2021
72cb9d4
update heading levels for myst rendering
JessicaS11 Dec 14, 2021
d690453
update heading levels for myst rendering
JessicaS11 Dec 14, 2021
d226b4f
update heading levels for myst rendering
JessicaS11 Dec 14, 2021
66032ac
fix heading level
JessicaS11 Dec 15, 2021
fa815d6
removed example notebooks subheading
JessicaS11 Dec 16, 2021
323235f
try decreasing maxdepth
JessicaS11 Dec 16, 2021
2072419
decrease examples.rst maxdepth
JessicaS11 Dec 16, 2021
3c04e2e
Revert "decrease examples.rst maxdepth"
JessicaS11 Dec 16, 2021
4ecc192
Merge branch 'development' into myst-nb
JessicaS11 Dec 20, 2021
fd237e7
Fix code of conduct link
weiji14 Dec 20, 2021
846d7cf
Fix changelog rst errors
weiji14 Dec 20, 2021
db480e7
Increase jupyter notebook section heading levels
weiji14 Dec 20, 2021
340d47c
Remove duplicate headings in data variables notebook
weiji14 Dec 20, 2021
a161b42
Turn examples into a dedicated section
weiji14 Dec 21, 2021
3b003bb
Revert "Fix code of conduct link"
JessicaS11 Dec 21, 2021
541caf6
fix code of conduct link
JessicaS11 Dec 21, 2021
e478588
Revert "Turn examples into a dedicated section"
JessicaS11 Dec 21, 2021
77a93b1
Revert "Increase jupyter notebook section heading levels"
JessicaS11 Dec 21, 2021
2cbf85b
add heading to code of conduct link
JessicaS11 Dec 21, 2021
4ca39d8
add parser to code of conduct link
JessicaS11 Dec 21, 2021
22db87d
re-fix code of conduct badge target link
JessicaS11 Dec 21, 2021
01fd47f
try removing extra header level for coc
JessicaS11 Dec 21, 2021
388f843
GitHub action UML generation auto-update
JessicaS11 Dec 21, 2021
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
32 changes: 0 additions & 32 deletions doc/source/_templates/layout.html

This file was deleted.

20 changes: 13 additions & 7 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
import datetime

import icepyx
import recommonmark


# -- Project information -----------------------------------------------------

Expand All @@ -36,16 +34,21 @@
"sphinx.ext.autodoc",
"sphinx.ext.autosectionlabel",
"numpydoc",
"nbsphinx",
"recommonmark",
# "sphinx.ext.autosummary",
"myst_nb",
"contributors", # custom extension, from pandas
"sphinxcontrib.bibtex",
]
myst_enable_extensions = [
"linkify",
]

source_suffix = {
# Note, put .rst first so that API docs are linked properly
".rst": "restructuredtext",
".txt": "markdown",
".md": "markdown",
".ipynb": "myst-nb",
".txt": "myst-nb",
".md": "myst-nb",
}
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand All @@ -62,9 +65,12 @@
bibtex_bibfiles = ["tracking/icepyx_pubs.bib"]

# -- Configuration options ---------------------------------------------------
# Prefix document path to section labels, to use:
# `path/to/file:heading` instead of just `heading`
autosectionlabel_prefix_document = True
autosummary_generate = True
numpydoc_show_class_members = False

jupyter_execute_notebooks = "off"

# -- Options for HTML output -------------------------------------------------

Expand Down
3 changes: 2 additions & 1 deletion doc/source/contributing/code_of_conduct_link.rst
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.. include:: ../../../code_of_conduct.md
.. include:: ../../../code_of_conduct.md
:parser: myst_parser.sphinx_
Loading