Skip to content

Adds a user manual to dpctl documentation#712

Merged
oleksandr-pavlyk merged 12 commits intomasterfrom
docs/user-guide
Dec 23, 2021
Merged

Adds a user manual to dpctl documentation#712
oleksandr-pavlyk merged 12 commits intomasterfrom
docs/user-guide

Conversation

@diptorupd
Copy link
Copy Markdown
Contributor

@diptorupd diptorupd commented Dec 7, 2021

The PR will add a new user manual demonstrating the various features of dpctl from an end-user perspective.

@diptorupd
Copy link
Copy Markdown
Contributor Author

@oleksandr-pavlyk I closed the previous PR and opened the fresh one from a branch on our main repo rather than my fork.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Dec 7, 2021

@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented Dec 7, 2021

Coverage Status

Coverage remained the same at 81.527% when pulling 9829fd7 on docs/user-guide into a96214c on master.

@diptorupd diptorupd force-pushed the docs/user-guide branch 2 times, most recently from 2604713 to 3872302 Compare December 9, 2021 00:47
Comment thread docs/docfiles/user_guides/manual/intro.rst Outdated
@oleksandr-pavlyk oleksandr-pavlyk force-pushed the docs/user-guide branch 2 times, most recently from 0b3b37d to 0617448 Compare December 10, 2021 15:12
Comment thread docs/docfiles/user_guides/manual/intro.rst Outdated
Comment thread docs/docfiles/user_guides/manual/dpctl/intro.rst Outdated
@diptorupd
Copy link
Copy Markdown
Contributor Author

@oleksandr-pavlyk A rough draft for device selection is now added.

Comment thread docs/docfiles/user_guides/manual/dpctl/device_selection.rst Outdated
Comment thread docs/docfiles/user_guides/manual/dpctl/device_selection.rst Outdated
@oleksandr-pavlyk oleksandr-pavlyk force-pushed the docs/user-guide branch 2 times, most recently from 8c7d456 to 1c5f504 Compare December 15, 2021 20:26
Diptorup Deb and others added 5 commits December 20, 2021 23:53
  - Add a JSON file to store all urls.
  - Add a new extlinks_gen module to read urls from the urls.json
    into the extlinks dictionary read bu the sphinx.ext.extlinks
    module.
  - Use extlinks_gen inside conf.py.
  - Add license header and other minor changes to conf.py.
  - A page for the explaining device selection.
  - A page for defining platforms and demonstrating platform
    querying.
@diptorupd
Copy link
Copy Markdown
Contributor Author

@oleksandr-pavlyk I cleaned up and rebased the commits. Review once and we can merge.

Copy link
Copy Markdown
Contributor

@oleksandr-pavlyk oleksandr-pavlyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @diptorupd

@oleksandr-pavlyk oleksandr-pavlyk merged commit 0de1218 into master Dec 23, 2021
@oleksandr-pavlyk oleksandr-pavlyk deleted the docs/user-guide branch December 23, 2021 17:54
@github-actions
Copy link
Copy Markdown

Deleted rendered PR docs from intelpython.github.com/dpctl, latest should be updated shortly. 🤞

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants