Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ build:
tools:
python: "3.12"
sphinx:
configuration: docs/conf.py
fail_on_warning: true
python:
install:
Expand Down
7 changes: 7 additions & 0 deletions docs/admin/admin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Admin Guide"
---

# Admin Guide

General admin guide todo
6 changes: 0 additions & 6 deletions docs/admin/admin.rst

This file was deleted.

13 changes: 10 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
# -- Project information -----------------------------------------------------

project = 'Atlas'
copyright = '2024, Technical University of Munich, Applied Education Technologies'
copyright = '2025, Technical University of Munich, Applied Education Technologies'
author = 'Technical University of Munich, Applied Education Technologies'


Expand All @@ -33,13 +33,20 @@
# ones.
extensions = [
"sphinx_rtd_theme",
"sphinxcontrib.bibtex"
"sphinxcontrib.bibtex",
"myst_parser"
]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'venv']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'venv', 'README.md', 'requirements.txt']

source_suffix = {
'.rst': 'restructuredtext',
'.txt': 'markdown',
'.md': 'markdown',
}

linkcheck_ignore = [
r'http(s)?://.*localhost(:\d+)?/?',
Expand Down
7 changes: 7 additions & 0 deletions docs/dev/dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "Developer Guide"
---

# Developer Guide

General dev guide todo
6 changes: 0 additions & 6 deletions docs/dev/dev.rst

This file was deleted.

7 changes: 4 additions & 3 deletions docs/dev/setup/setup.rst → docs/dev/setup/setup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
.. _dev_setup:
---
title: "Setup Guide"
---

Setup Guide
===========
# Setup Guide

Setting up Atlas in your development environment or a demo production environment is really easy following
the instructions on this page.
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
*************
System Design
*************
---
title: "System Design"
---

Top-Level Design
================
# System Design

## Top-Level Design

The following diagram shows the top-level design of Atlas which is decomposed into the AtlasML server application that provides the REST API that learning management systems can connect to to integrate competency based learning into their systems.

Deployment
==========
## Deployment

TODO

Data Model
==========
## Data Model

TODO

Server Architecture
===================
## Server Architecture

TODO
36 changes: 36 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: "Atlas: Competency Based Learning Management System"
---

# Atlas: Competency Based Learning Management System

## Main features

Atlas main features

```{toctree}
:caption: User Guide
:includehidden:
:maxdepth: 3

user/user
```

```{toctree}
:caption: Contributor Guide
:includehidden:
:maxdepth: 3

dev/dev
dev/development-process/development-process
dev/system-design/system-design
dev/setup/setup
```

```{toctree}
:caption: Administration Guide
:includehidden:
:maxdepth: 3

admin/admin
```
34 changes: 0 additions & 34 deletions docs/index.rst

This file was deleted.

17 changes: 10 additions & 7 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
Sphinx==7.4.7
sphinx-rtd-theme==2.0.0
sphinx-autobuild==2024.9.19
sphinxcontrib-bibtex==2.6.3
alabaster==1.0.0
docutils==0.21.2
Jinja2==3.1.5
requests==2.32.3
zipp==3.20.2
docutils==0.20.1
urllib3==2.2.3
Sphinx==8.1.3
sphinx-rtd-theme==3.0.2
sphinx-autobuild==2024.10.3
sphinxcontrib-bibtex==2.6.3
urllib3==2.3.0
zipp==3.21.0
myst_parser==4.0.0
7 changes: 7 additions & 0 deletions docs/user/user.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: "User Guide"
---

# User Guide

General user guide todo
6 changes: 0 additions & 6 deletions docs/user/user.rst

This file was deleted.