From 6e66a94421081f3dfc99aa4cd53b7728ebd9690b Mon Sep 17 00:00:00 2001 From: Tobias Ribizel Date: Mon, 18 Jul 2022 14:07:32 +0200 Subject: [PATCH] fix documentation URL in remaining places --- CHANGELOG.md | 2 +- CONTRIBUTING.md | 2 +- README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e1e411bea44..43abc3da802 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -585,7 +585,7 @@ To learn how to use Ginkgo, and get ideas for your own projects, take a look at * [`three-pt-stencil-solver`](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/examples/three-pt-stencil-solver) is a variation of the `poisson_solver` that demonstrates how one could use Ginkgo with software that was not originally designed with Ginkgo support. It encapsulates everything related to Ginkgo in a single function that accepts raw data of the problem and demonstrates how such data can be directly used with Ginkgo's components. * [`inverse-iteration`](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/examples/inverse-iteration) is another full application that uses Ginkgo's solver as a component for implementing the inverse iteration eigensolver. -You can also check out Ginkgo's [core](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/core/test) and [reference](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/reference/test) unit tests and [benchmarks](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/benchmark) for more detailed examples of using each of the components. A complete Doxygen-generated reference is available [online](https://ginkgo-project.github.io/ginkgo/doc/v1.0.0/), or you can find the same information by directly browsing Ginkgo's [headers](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/include/ginkgo). We are investing significant efforts in maintaining good code quality, so you should not find them difficult to read and understand. +You can also check out Ginkgo's [core](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/core/test) and [reference](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/reference/test) unit tests and [benchmarks](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/benchmark) for more detailed examples of using each of the components. A complete Doxygen-generated reference is available [online](https://ginkgo-project.github.io/ginkgo-generated-documentation/doc/v1.0.0/), or you can find the same information by directly browsing Ginkgo's [headers](https://github.com/ginkgo-project/ginkgo/tree/v1.0.0/include/ginkgo). We are investing significant efforts in maintaining good code quality, so you should not find them difficult to read and understand. If you want to use your own functionality with Ginkgo, these examples are the best way to start: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f2fb51215a2..fa927ccef81 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -558,7 +558,7 @@ There are two main steps: + In `short-intro`: The name of the example. + In `results.dox`: Run the example and write the output you get. + In `kind`: The kind of the example. For different kinds see [the - documentation](https://ginkgo-project.github.io/ginkgo/doc/develop/Examples.html). + documentation](https://ginkgo-project.github.io/ginkgo-generated-documentation/doc/develop/Examples.html). Examples can be of `basic`, `techniques`, `logging`, `stopping_criteria` or `preconditioners`. If your example does not fit any of these categories, feel free to create one. diff --git a/README.md b/README.md index b192aab98f8..61b64c24529 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ An example can be found in the [`test_install`](test_install/CMakeLists.txt). ### Ginkgo Examples -Various examples are available for you to understand and play with Ginkgo within the `examples/` directory. They can be compiled by passing the `-DGINKGO_BUILD_EXAMPLES=ON` to the cmake command. Documentation for the examples is available within the `doc/` folder in each of the example directory and a commented code with explanations can found in the [online documentation](https://ginkgo-project.github.io/ginkgo/doc/develop/Examples.html). +Various examples are available for you to understand and play with Ginkgo within the `examples/` directory. They can be compiled by passing the `-DGINKGO_BUILD_EXAMPLES=ON` to the cmake command. Documentation for the examples is available within the `doc/` folder in each of the example directory and a commented code with explanations can found in the [online documentation](https://ginkgo-project.github.io/ginkgo-generated-documentation/doc/develop/Examples.html). ### Ginkgo Testing