8000 Fix examples in docs by danvratil · Pull Request #128 · qcoro/qcoro · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix examples in docs #128

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.

Sign up for GitHub

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 2 commits into from
Oct 18, 2022
Merged

Fix examples in docs #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
940ae2f
ci(docs): enable verbose output when building docs
danvratil Oct 18, 2022
a0b8026
docs: fix including examples with include-markdown
danvratil Oct 18, 2022
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
2 changes: 1 addition & 1 deletion .github/workflows/update-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ jobs:
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.type='text/javascript'; g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();</script><!-- End Matomo Code -->{% endblock %}" > docs/overrides/main.html
mkdocs build
mkdocs build --verbose
- name: Deploy Github Pages
uses: peaceiris/actions-gh-pages@v3
with:
Expand Down
13 changes: 5 additions & 8 deletions docs/reference/core/qfuture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,11 @@ QCoroFuture qCoro(const QFuture<T> &future);

## `waitForFinished()`

{%
include-markdown "../../../qcoro/core/qcorofuture.h"
dedent=true
rewrite-relative-urls=false
start="<!-- doc-waitForFinished-start -->"
end="<!-- doc-waitForFinished-end -->"
%}

{% include-markdown "../../../qcoro/core/qcorofuture.h"
dedent=true
rewrite-relative-urls=false
start="<!-- doc-waitForFinished-start -->"
end="<!-- doc-waitForFinished-end -->" %}

## Example

Expand Down
12 changes: 5 additions & 7 deletions docs/reference/dbus/qdbuspendingcall.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,11 @@ const QDBusReply<...> reply = co_await pendigCall;

## `waitForFinished()`

{%
include-markdown "../../../qcoro/dbus/qcorodbuspendingcall.h"
dedent=true
rewrite-relative-urls=false
start="<!-- doc-waitForFinished-start -->"
end="<!-- doc-waitForFinished-end -->"
%}
{% include-markdown "../../../qcoro/dbus/qcorodbuspendingcall.h"
dedent=true
rewrite-relative-urls=false
start="<!-- doc-waitForFinished-start -->"
end="<!-- doc-waitForFinished-end -->" %}

## Example

Expand Down
12 changes: 5 additions & 7 deletions docs/reference/dbus/qdbuspendingreply.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,11 @@ co_await reply;

## `waitForFinished()`

{%
include-markdown "../../../qcoro/dbus/qcorodbuspendingreply.h"
dedent=true
rewrite-relative-urls=false
start="<!-- doc-waitForFinished-start -->"
end="<!-- doc-waitForFinished-end -->"
%}
{% include-markdown "../../../qcoro/dbus/qcorodbuspendingreply.h"
dedent=true
rewrite-relative-urls=false
start="<!-- doc-waitForFinished-start -->"
end="<!-- doc-waitForFinished-end -->" %}

## Example

Expand Down
0