Skip to content

Commit

Permalink
[doc] move user-guide pages to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcelKoch committed Sep 13, 2024
1 parent 586f8ec commit b2523eb
Show file tree
Hide file tree
Showing 12 changed files with 28 additions and 38 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ implemented for NVIDIA, AMD and Intel GPUs.

# Prerequisites

### Linux and Mac OS
### Linux and macOS

For Ginkgo core library:

Expand Down Expand Up @@ -101,7 +101,7 @@ The Ginkgo OMP module has the following __additional__ requirements:
* _MinGW_

In these environments, two problems can be encountered, the solution for which is described in the
[windows section in INSTALL.md](INSTALL.md#building-ginkgo-in-windows):
[windows section in INSTALL.md](doc/user-guide/INSTALL.md#building-ginkgo-in-windows):
* `ld: error: export ordinal too large` needs the compilation flag `-O1`
* `cc1plus.exe: out of memory allocating 65536 bytes` requires a modification of the environment

Expand All @@ -124,7 +124,7 @@ modules depending on your machine environment (present of CUDA, ...). You can
also explicitly compile with the OpenMP, CUDA, HIP or DPC++(SYCL) modules enabled to
run the examples with these executors.

Please refer to the [Installation page](./INSTALL.md) for more details.
Please refer to the [Installation page](doc/user-guide/INSTALL.md) for more details.

Tip: After installation, in your CMake project, Ginkgo can be added with `find_package(Ginkgo)` and the the target that is exported is `Ginkgo::ginkgo`.
An example can be found in the [`test_install`](test/test_install/CMakeLists.txt).
Expand All @@ -144,15 +144,15 @@ Various examples are available for you to understand and play with Ginkgo within
A unique feature of Ginkgo is the ability to run benchmarks and view your results
with the help of the [Ginkgo Performance Explorer (GPE)](https://ginkgo-project.github.io/gpe/).

More details about this can be found in the [BENCHMARKING.md page](./BENCHMARKING.md)
More details about this can be found in the [BENCHMARKING.md page](doc/user-guide/BENCHMARKING.md)

# Bug reports and Support

If you have any questions about using Ginkgo, please use [Github discussions](https://github.com/ginkgo-project/ginkgo/discussions).

If you would like to request a feature, or have encountered a bug, please [create an issue](https://github.com/ginkgo-project/ginkgo/issues/new). Please be sure to describe your problem and provide as much information as possible.

You can also send an email to [Ginkgo's main email address](mailto:[email protected]).
You can also email [Ginkgo's main email address](mailto:[email protected]).

# Licensing

Expand All @@ -166,7 +166,7 @@ details.

# Contributing to Ginkgo

We are glad that that you would like to contribute to Ginkgo and we are happy to help you with any questions you may have.
We are glad that you would like to contribute to Ginkgo, and we are happy to help you with any questions you may have.

If you are contributing for the first time, please add yourself to the list of external contributors with the following info

Expand All @@ -185,7 +185,7 @@ license, as specified in the repository's LICENSE file.

#### Contribution Guidelines

When contributing to Ginkgo, to ease the review process, please follow the guidelines mentioned in [CONTRIBUTING.md](CONTRIBUTING.md).
When contributing to Ginkgo, to ease the review process, please follow the guidelines mentioned in [CONTRIBUTING.md](doc/user-guide/CONTRIBUTING.md).

It also contains other general recommendations such as writing proper commit messages, understanding Ginkgo's library design, relevant C++ information etc.

Expand Down Expand Up @@ -216,4 +216,4 @@ pages = {2:1--2:33}
```

For more information on topical subjects, please refer to the [CITING.md
page](CITING.md).
page](doc/user-guide/CITING.md).
8 changes: 4 additions & 4 deletions doc/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# User Guide

This is the main page for the Ginkgo library user documentation. The repository is hosted on [github](https://github.com/ginkgo-project/ginkgo).
Documentation on aspects such as the build system, can be found at the [install page](user-guide/using-ginkgo.md).
Documentation on aspects such as the build system, can be found at the [install page](user-guide/INSTALL.md).
The {doxy}`Examples` can help you get started with using Ginkgo.

The Ginkgo library can be grouped into modules which form the basic building blocks of Ginkgo. The modules can be summarized as follows:
Expand All @@ -24,9 +24,9 @@ The Ginkgo library can be grouped into modules which form the basic building blo

Tutorial <https://github.com/ginkgo-project/ginkgo/wiki/Tutorial:-Building-a-Poisson-Solver>
Examples <_doxygen/html/Examples.html#https://>
Publications <user-guide/publications>
user-guide/contributing
Using Ginkgo <user-guide/using-ginkgo>
Publications <user-guide/CITING>
user-guide/CONTRIBUTING
Using Ginkgo <user-guide/INSTALL>
API <_doxygen/html/index.html#https://>
:::

Expand Down
File renamed without changes.
6 changes: 6 additions & 0 deletions CITING.md → doc/user-guide/CITING.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,9 @@ keywords = {irregular matrices, GPUs, Sparse Matrix Vector Product (SpMV)}
primaryClass={cs.MS}
}
```

:::{toctree}
self
Ginkgo White Paper <https://www.arxiv-vanity.com/papers/2006.16852>
Slides and Outreach <https://github.com/ginkgo-project/outreach>
:::
File renamed without changes.
11 changes: 9 additions & 2 deletions INSTALL.md → doc/user-guide/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Additionally, the following CMake options have effect on the build process:

For example, to build everything (in debug mode), use:

```cmake
```bash
cmake .. -BDebug -DCMAKE_BUILD_TYPE=Debug -DGINKGO_DEVEL_TOOLS=ON \
-DGINKGO_BUILD_TESTS=ON -DGINKGO_BUILD_REFERENCE=ON -DGINKGO_BUILD_OMP=ON \
-DGINKGO_BUILD_CUDA=ON -DGINKGO_BUILD_HIP=ON
Expand Down Expand Up @@ -246,4 +246,11 @@ user, e.g. when installing Ginkgo system-wide, it might be necessary to prefix
the call with `sudo`.

After the installation, CMake can find ginkgo with `find_package(Ginkgo)`.
An example can be found in the [`test_install`](test/test_install/CMakeLists.txt).
An example can be found in the [`test_install`](../../test/test_install/CMakeLists.txt).

:::{toctree}
:hidden:
self
TESTING
BENCHMARKING
:::
2 changes: 1 addition & 1 deletion TESTING.md → doc/user-guide/TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ make test

The output should contain several lines of the form:

```
```text
Start 1: path/to/test
1/13 Test #1: path/to/test ............................. Passed 0.01 sec
```
Expand Down
2 changes: 0 additions & 2 deletions doc/user-guide/benchmarking.md

This file was deleted.

2 changes: 0 additions & 2 deletions doc/user-guide/contributing.md

This file was deleted.

8 changes: 0 additions & 8 deletions doc/user-guide/publications.md

This file was deleted.

2 changes: 0 additions & 2 deletions doc/user-guide/testing.md

This file was deleted.

9 changes: 0 additions & 9 deletions doc/user-guide/using-ginkgo.md

This file was deleted.

0 comments on commit b2523eb

Please sign in to comment.