% ReEDS documentation master file, created by
% sphinx-quickstart on Fri Jan 12 12:05:28 2024.
% You can adapt this file completely to your liking, but it should at least
% contain the root `toctree` directive.

# Welcome to ReEDS's documentation!

```{include} ../../README.md 
```

```{toctree}
:caption: Contents
:hidden:

setup
internal/additional_setup
internal/developer_best_practices
internal/onboarding
model_documentation
user_guide
sources
postprocessing_tools
publications
faq
```


<!--
note: to change the maxdepth of the toctree, you need to change 'navigation_depth' found in conf.py under 'html_theme_options'
-->