Skip to content

Upload RST docs to the website and add navigation there, add website link to README.md #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 12, 2025
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
7 changes: 1 addition & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![codecov](https://codecov.io/gh/learning-process/parallel_programming_course/graph/badge.svg?token=qCOtqeFyIz)](https://codecov.io/gh/learning-process/parallel_programming_course)

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

### Parallel programming technologies:
The following parallel programming technologies are considered in practice:
Expand All @@ -15,9 +16,3 @@
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).
* Respect others time and don't slow down the job queue
2. Carefully check if the program can hang.

### Steps to create a task:
1. [Download all submodules](docs/download.rst)
2. [Set up your environment](docs/environment.rst)
3. [Build the project with `CMake`](docs/build.rst)
4. [How to submit your current work](docs/submit_work.rst)
16 changes: 6 additions & 10 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
.. Parallel Programming Course documentation master file, created by
sphinx-quickstart on Sat Jan 11 23:09:04 2025.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Parallel Programming Course documentation
=========================================

Add your content using ``reStructuredText`` syntax. See the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
documentation for details.

Below is the table of contents for the Parallel Programming Course documentation. Follow the links to learn more about each topic.

.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: User Guide:

user_guide/build
user_guide/download
user_guide/environment
user_guide/submit_work
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading