Skip to content

Commit 2e969c3

Browse files
authored
Upload RST docs to the website and add navigation there, add website link to README.md (#195)
1 parent f011d22 commit 2e969c3

File tree

6 files changed

+7
-16
lines changed

6 files changed

+7
-16
lines changed

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
[![codecov](https://codecov.io/gh/learning-process/parallel_programming_course/graph/badge.svg?token=qCOtqeFyIz)](https://codecov.io/gh/learning-process/parallel_programming_course)
33

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

67
### Parallel programming technologies:
78
The following parallel programming technologies are considered in practice:
@@ -14,9 +15,3 @@
1415
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).
1516
* Respect others time and don't slow down the job queue
1617
2. Carefully check if the program can hang.
17-
18-
### Steps to create a task:
19-
1. [Download all submodules](docs/download.rst)
20-
2. [Set up your environment](docs/environment.rst)
21-
3. [Build the project with `CMake`](docs/build.rst)
22-
4. [How to submit your current work](docs/submit_work.rst)

docs/index.rst

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
.. Parallel Programming Course documentation master file, created by
2-
sphinx-quickstart on Sat Jan 11 23:09:04 2025.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
5-
61
Parallel Programming Course documentation
72
=========================================
83

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-
4+
Below is the table of contents for the Parallel Programming Course documentation. Follow the links to learn more about each topic.
135

146
.. toctree::
157
:maxdepth: 2
16-
:caption: Contents:
8+
:caption: User Guide:
179

10+
user_guide/build
11+
user_guide/download
12+
user_guide/environment
13+
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)