Skip to content

Commit 5666a00

Browse files
committed
Upload RST docs to the website and add navigation there, add website link to README.md
1 parent f4a5c8e commit 5666a00

File tree

6 files changed

+7
-11
lines changed

6 files changed

+7
-11
lines changed

README.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![codecov](https://codecov.io/gh/learning-process/parallel_programming_course/graph/badge.svg?token=qCOtqeFyIz)](https://codecov.io/gh/learning-process/parallel_programming_course)
44

55
# Parallel Programming Course
6+
Welcome to the Parallel Programming Course! For more detailed documentation and resources, please visit [documentation page](https://learning-process.github.io/parallel_programming_course/).
67

78
### Parallel programming technologies:
89
The following parallel programming technologies are considered in practice:
@@ -15,9 +16,3 @@
1516
1. You are not supposed to trigger CI jobs by frequent updates of your pull request. First you should test you work locally with all the scripts (code style).
1617
* Respect others time and don't slow down the job queue
1718
2. Carefully check if the program can hang.
18-
19-
### Steps to create a task:
20-
1. [Download all submodules](docs/download.rst)
21-
2. [Set up your environment](docs/environment.rst)
22-
3. [Build the project with `CMake`](docs/build.rst)
23-
4. [How to submit your current work](docs/submit_work.rst)

docs/index.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@
66
Parallel Programming Course documentation
77
=========================================
88

9-
Add your content using ``reStructuredText`` syntax. See the
10-
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11-
documentation for details.
12-
9+
Below is the table of contents for the Parallel Programming Course documentation. Follow the links to learn more about each topic.
1310

1411
.. toctree::
1512
:maxdepth: 2
16-
:caption: Contents:
13+
:caption: User Guide:
1714

15+
user_guide/build
16+
user_guide/download
17+
user_guide/environment
18+
user_guide/submit_work
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)