Skip to content

Commit c31cb0f

Browse files
committed
add support to include markdown files in tutorials
1 parent bd5b3a4 commit c31cb0f

5 files changed

Lines changed: 13 additions & 91 deletions

doc/Downloading_the_ECCO_v4_state_estimate.rst

Lines changed: 0 additions & 86 deletions
This file was deleted.

doc/Downloading_ECCO_Datasets_from_PODAAC_wget.md renamed to doc/Tutorial_wget_Command_Line_HTTPS_Downloading_ECCO_Datasets_from_PODAAC.md

File renamed without changes.

doc/conf.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@
4646
'sphinx.ext.autosummary',
4747
'sphinx.ext.extlinks',
4848
'sphinx.ext.napoleon',
49-
'nbsphinx'
49+
'nbsphinx',
50+
'myst_parser'
5051
]
5152
# Napoleon settings
5253
napoleon_google_docstring = True
@@ -68,6 +69,9 @@
6869
numpydoc_class_members_toctree = True
6970
numpydoc_show_class_members = False
7071

72+
#html_math_renderer = 'imgmath'
73+
#imgmath_image_format = 'svg'
74+
#imgmath_font_size = 14
7175

7276
# Add any paths that contain templates here, relative to this directory.
7377
templates_path = ['_templates']
@@ -91,16 +95,16 @@
9195
# built documents.
9296
#
9397
# The short X.Y version.
94-
version = u'4.4-20221215'
98+
version = u'4.4'
9599
# The full version, including alpha/beta/rc tags.
96-
release = u'4.4-20221215'
100+
release = u'4.4.1'
97101

98102
# The language for content autogenerated by Sphinx. Refer to documentation
99103
# for a list of supported languages.
100104
#
101105
# This is also used if you do content translation via gettext catalogs.
102106
# Usually you set "language" from the command line for these cases.
103-
language = None
107+
language ='en'
104108

105109
# List of patterns, relative to source directory, that match files and
106110
# directories to ignore when looking for source files.

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The `ecco_v4_py`_ package used in this tutorial was inspired by the `xmitgcm`_ p
2929
fields
3030
Installing_Python_and_Python_Packages
3131
Downloading_ECCO_Datasets_from_PODAAC_Python.ipynb
32-
Downloading_ECCO_Datasets_from_PODAAC_wget.md
32+
Tutorial_wget_Command_Line_HTTPS_Downloading_ECCO_Datasets_from_PODAAC
3333
Tutorial_Introduction
3434

3535
.. toctree::

requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,14 @@ jinja2==3.1.2
2525
# via sphinx
2626
markupsafe==2.1.1
2727
# via jinja2
28+
myst-parser==1.0.0
29+
# to include markdown file
2830
nbsphinx==0.9.1
2931
# from readthedocs log file
3032
packaging==22.0
3133
# via sphinx
34+
pandoc==2.3
35+
# from sphinx website
3236
pygments==2.13.0
3337
# via sphinx
3438
pytz==2022.7

0 commit comments

Comments
 (0)