Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ac84dda

Browse files
KobzolKobzol
committed
Inline examples into docs
With examples living in a separate directory, it was not easily possible to link to the documentation so that it would work also on GitHub. Instead, we can just link to the `docs/examples` directory directly from GitHub.
1 parent 7daeecf commit ac84dda

5 files changed

Lines changed: 6 additions & 34 deletions

File tree

‎README.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ as a general distributed task execution engine.
1212

1313
[Documentation](https://it4innovations.github.io/hyperqueue/)
1414

15-
If you find a bug or a problem with HyperQueue, please create an [issue](https://github.com/It4innovations/hyperqueue/issues).
16-
For more general discussion or feature requests, please use our
17-
[discussion forum](https://github.com/It4innovations/hyperqueue/discussions). If you want to chat
18-
with the HyperQueue developers, you can use our [Zulip](https://hyperqueue.zulipchat.com/) server.
15+
- You can check out [examples](docs/examples) to see how to use HyperQueue.
16+
- If you find a bug or a problem with HyperQueue, please create an [issue](https://github.com/It4innovations/hyperqueue/issues).
17+
- For more general discussion or feature requests, please use our
18+
[discussion forum](https://github.com/It4innovations/hyperqueue/discussions).
19+
- If you want to chat with the HyperQueue developers, you can use our [Zulip](https://hyperqueue.zulipchat.com/) server.
1920

20-
If you use HyperQueue in your research, please consider [citing it](#publications).
21+
> If you use HyperQueue in your research, please consider [citing it](#publications).
2122
2223
This image shows how HyperQueue can work on a distributed cluster that uses Slurm or PBS:
2324

examples/README.md renamed to docs/examples/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,4 @@
22
Here you can find several examples of how HyperQueue can be used for various use-cases, both with the command-line
33
interface and also with the Python API.
44

5-
You can view these examples either in the [documentation](https://it4innovations.github.io/hyperqueue/stable/examples/iterative-computation/)
6-
or on [GitHub](https://github.com/It4innovations/hyperqueue/tree/main/examples).
7-
85
- [Iterative computation](./iterative-computation/README.md)

examples/iterative-computation/README.md renamed to docs/examples/iterative-computation/README.md

File renamed without changes.

‎mkdocs.yml‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ edit_uri: blob/main/docs/
77
site_description: Documentation of HyperQueue.
88
site_author: Ada Böhm, Jakub Beránek
99

10-
watch:
11-
- examples
12-
1310
validation:
1411
links:
1512
# FIXME: we ignore the warning because of apidoc and cli-reference
@@ -108,7 +105,6 @@ plugins:
108105

109106
hooks:
110107
- scripts/docs/build_cli_reference.py
111-
- scripts/docs/copy_examples.py
112108

113109
extra:
114110
analytics:

‎scripts/docs/copy_examples.py‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)