Skip to content

Commit

Permalink
docs: added additional docs for data_standards
Browse files Browse the repository at this point in the history
  • Loading branch information
snehasaisneha committed Apr 18, 2024
1 parent 7321298 commit f2e8292
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 1 deletion.
18 changes: 18 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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.
5 changes: 5 additions & 0 deletions docs/data_standards/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Data Standards

Welcome to the Data Standards section.

{{ toctree }}
3 changes: 3 additions & 0 deletions docs/data_standards/roles/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Roles

Different User Roles used in Evironmental Surveillance
1 change: 1 addition & 0 deletions docs/data_standards/users/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Different Users in Environmental Surveillance
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
```{include} ../README.md
```

## [Data Standards](data_standards/)

```{toctree}
:maxdepth: 1
:maxdepth: 2
:hidden:
example.ipynb
Expand Down

0 comments on commit f2e8292

Please sign in to comment.