From f2e8292726434d24f8ca70306cfe92fe142f1523 Mon Sep 17 00:00:00 2001 From: Sai Sneha Date: Thu, 18 Apr 2024 14:08:59 +0530 Subject: [PATCH] docs: added additional docs for data_standards --- docs/conf.py | 18 ++++++++++++++++++ docs/data_standards/index.md | 5 +++++ docs/data_standards/roles/index.md | 3 +++ docs/data_standards/users/index.md | 1 + docs/index.md | 4 +++- 5 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 docs/data_standards/index.md create mode 100644 docs/data_standards/roles/index.md create mode 100644 docs/data_standards/users/index.md diff --git a/docs/conf.py b/docs/conf.py index 11dbedd..4248bbc 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,6 +4,9 @@ # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +import os +import sys + # -- Project information ----------------------------------------------------- project = u"dses" @@ -34,3 +37,18 @@ # a list of builtin themes. # html_theme = "sphinx_rtd_theme" + +# -- Options for Markdown rendering ------------------------------------------ + +# Add the data_standards directory to the source directory +source_dir = os.path.abspath(os.path.dirname(__file__)) +data_standards_dir = os.path.join(source_dir, "data_standards") + +# Include data_standards directory for Markdown rendering +myst_include_patterns = [data_standards_dir] + +# Recursively include subdirectories of data_standards +myst_include_directories = [data_standards_dir] + +# If you want to customize how files in data_standards are rendered, +# you can do so using the `myst_custom_renderers` setting. diff --git a/docs/data_standards/index.md b/docs/data_standards/index.md new file mode 100644 index 0000000..51cc3ce --- /dev/null +++ b/docs/data_standards/index.md @@ -0,0 +1,5 @@ +# Data Standards + +Welcome to the Data Standards section. + +{{ toctree }} diff --git a/docs/data_standards/roles/index.md b/docs/data_standards/roles/index.md new file mode 100644 index 0000000..8e8f716 --- /dev/null +++ b/docs/data_standards/roles/index.md @@ -0,0 +1,3 @@ +# Roles + +Different User Roles used in Evironmental Surveillance \ No newline at end of file diff --git a/docs/data_standards/users/index.md b/docs/data_standards/users/index.md new file mode 100644 index 0000000..5d06a2e --- /dev/null +++ b/docs/data_standards/users/index.md @@ -0,0 +1 @@ +# Different Users in Environmental Surveillance \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 6fcdc0e..1e10e27 100755 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,10 @@ ```{include} ../README.md ``` +## [Data Standards](data_standards/) + ```{toctree} -:maxdepth: 1 +:maxdepth: 2 :hidden: example.ipynb