Skip to content

Commit

Permalink
Add readthedocs and mkdocs config and docs stubs
Browse files Browse the repository at this point in the history
  • Loading branch information
danielhollas committed Sep 8, 2023
1 parent 21f0d4d commit 28373b7
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Read the Docs configuration file for MkDocs projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

mkdocs:
configuration: mkdocs.yml

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
49 changes: 49 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Welcome to ATMOSPEC

**WARNING: This documentation is a work in progress, please check back later. :-)**

Welcome to the ATMOSPEC documentation!
For a quick intro to how the program looks and works, take a look at this [short screencast](https://youtu.be/1ePj1hhOFdw).

## Installation

### Install dependencies
0. [Install ORCA](https://www.orcasoftware.de/tutorials_orca/first_steps/install.html)

NOTE: If you're downloading for Linux, choose the "shared-version", which has much smaller download size.

1. [Install Docker](https://docs.docker.com/engine/install/#server)

```console
sudo apt install docker.io
```

Then add yourself to the `docker` unix group and restart the shell session

```console
sudo usermod -a -G docker $USER
```

2. Install pipx

```console
sudo apt install python-venv pipx
```

3. Install `aiidalab-launch` to manage the AiiDAlab containers

```console
pipx install aiidalab-launch
```

If pipx is giving you trouble, you should be able to install via pip as well.

TODO: Take this from README

## Quick guide

TODO: Screenshots here

## Acknowledgements

This project has been funded by European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (Grant agreement No. 803718, [project SINDAM](https://cordis.europa.eu/project/id/803718)), and the EPSRC Grant EP/V026690/1 [UPDICE](https://updiceproject.com).
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mkdocs~=1.5.0
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site_name: Atmospec Docs

0 comments on commit 28373b7

Please sign in to comment.