Skip to content

Commit

Permalink
Added all wiki articles to the documentation, changed the theme
Browse files Browse the repository at this point in the history
fixed sphinx command

changed the links in the repo to point to the documentation
  • Loading branch information
trbKnl committed Sep 27, 2024
1 parent 56b7a44 commit f81674f
Show file tree
Hide file tree
Showing 15 changed files with 880 additions and 19 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ jobs:
- uses: actions/setup-python@v5
- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
pip install sphinx sphinx_rtd_theme myst_parser piccolo_theme
- name: Sphinx build
run: |
sphinx-build doc _build
sphinx-build doc/source _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: gh-pages-docs
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
force_orphan: true
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
/coverage
/_build
/.venv
**/**/__pycache__

# production
/build
Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ A typical script includes the following steps:
A example such a script is included in this repo: [`script.py`](src/framework/processing/py/port/script.py).
We recommend you use that script as starting point for your own data donation study.

Check out the [wiki](https://github.com/d3i-infra/data-donation-task/wiki) for a tutorial on how to start writing your own `script.py`.
Check out the [documentation](https://d3i-infra.github.io/data-donation-task/) for a tutorial on how to start writing your own `script.py`.


## Installation of the data donation task
Expand Down Expand Up @@ -101,20 +101,25 @@ In order to start a local instance of the data donation task go through the foll
3. You can now go to the browser: [`http://localhost:3000`](http://localhost:3000).

If the installation went correctly you should be greeted with a mock data donation study.
For detailed installation instructions see the [wiki](https://github.com/d3i-infra/data-donation-task/wiki).
For detailed installation instructions see the [documentation](https://d3i-infra.github.io/data-donation-task/).


## Feldspar and Next

The data donation task is primarily created to be used in conjunction with [Next](https://github.com/eyra/mono). Next is a software as a service platform developed by [Eyra](https://eyra.co/) to facilitate scientific research.
The data donation task is a fork of [Feldspar](https://github.com/eyra/feldspar) with some extra functionalities added to it. Feldspar is a framework which can be used to build applications specifically for Next. An example of such an application is the data donation task which you can find in this repository.

For detailed information on how to deploy the data donation task with Next check the [wiki](https://github.com/d3i-infra/data-donation-task/wiki).
For detailed information on how to deploy the data donation task with Next check the [documentation](https://d3i-infra.github.io/data-donation-task/).

_Note_: The data donation task is only a *front end* to be used with Next. In order for it to be used in a live study it needs to be hosted with Next.
The wiki will discuss the options you have for using the data donation task in an actual study.


## Documentation

Here you can find the [documentation](https://d3i-infra.github.io/data-donation-task/)


## Contributing

We want to make contributing to this project as easy and transparent as possible, whether it's:
Expand Down
8 changes: 0 additions & 8 deletions doc/index.rst

This file was deleted.

2 changes: 1 addition & 1 deletion doc/api.md → doc/source/api/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@
```{eval-rst}
.. automodule:: port.platforms.chatgpt
:members:
```
```
7 changes: 7 additions & 0 deletions doc/source/api/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
API Documentation
=============================

.. toctree::
:maxdepth: 3

api.md
Loading

0 comments on commit f81674f

Please sign in to comment.