Skip to content

Commit

Permalink
first content
Browse files Browse the repository at this point in the history
  • Loading branch information
surchs committed May 13, 2021
1 parent b7e2cdd commit 5f54253
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Douglas Neuroinformatics Platform Documentation

Hello

## To build locally

Follow these steps.

1. install `requirements.txt`
2. `cd docs` and then `make html`
3. open `docs/_build/index.html`

To make changes, edit the markdown files.

Also check out

- [MyST docs](https://myst-parser.readthedocs.io/en/latest/)
- [SPHINX docs](https://www.sphinx-doc.org/en/master/usage/quickstart.html)
11 changes: 11 additions & 0 deletions docs/getting_started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Getting started

Hello. Happy to get you started

## Set up a user account

Here is how to do it

## Ask a support question

Here is how you do that.
10 changes: 10 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Douglas Neuroinformatics Platform Documentation

Hello and welcome to our documentation page.

```{toctree}
---
maxdepth: 2
caption: Things we know about
---
getting_started/index.md

0 comments on commit 5f54253

Please sign in to comment.