<!-- GPE
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
-->


<!-- Include ../README.md
     If you would like to use the contents of your top-level README.md file here, then
     you can literally include it here with the following:

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

# GPE

Welcome to the documentation for GPE!  To get started, please see {ref}`sec:GettingStarted`.

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

```{toctree}
---
maxdepth: 2
caption: "Tutorial:"
titlesonly:
hidden:
glob:
---
Tutorial/*
```

Another option is to symlink the file into the `Docs/` tree and then include it as part
of the documentation.  Note that this will probably not work on Windows.

````bash
cd Docs/
ln -s ../README.md .
hg add README.md
````

```{toctree}
---
maxdepth: 2
caption: "Contents:"
titlesonly:
hidden:
glob:
---
dr-GPE/*
Notes/*
References
```

```{toctree}
---
maxdepth: 2
caption: "dr-GPE:"
titlesonly:
hidden:
---
dr-GPE/dr-GPE
```

```{toctree}
---
maxdepth: 2
caption: "Examples:"
hidden:
glob:
---
Examples/*
```

```{toctree}
---
maxdepth: 2
caption: "SOC:"
glob:
---
../SOC/*.md
```

```{toctree}
---
maxdepth: 2
caption: "Code Structure:"
hidden:
glob:
---
Architecture/*
Notes
```

```{toctree}
---
maxdepth: 2
caption: "Miscellaneous:"
hidden:
---
Demonstration
CoCalc
```

[JupyterBook]: <https://jupyterbook.org>