Skip to content

Doc improvement#341

Closed
diptorupd wants to merge 26 commits intoIntelPython:masterfrom
diptorupd:doc-improvement
Closed

Doc improvement#341
diptorupd wants to merge 26 commits intoIntelPython:masterfrom
diptorupd:doc-improvement

Conversation

@diptorupd
Copy link
Copy Markdown
Contributor

@diptorupd diptorupd commented Mar 31, 2021 •
edited
Loading

Various improvements to dpctl documentation website.

  • We now use doxyrest to generate C API docs.
  • A new QuickStart guide
  • Reorganizing the docs directory
  • Change existing file names.

@diptorupd diptorupd marked this pull request as draft March 31, 2021 02:57
PokhodenkoSA
PokhodenkoSA reviewed Mar 31, 2021
View reviewed changes
Comment thread docs/.gitignore Outdated
@oleksandr-pavlyk
Copy link
Copy Markdown
Contributor

oleksandr-pavlyk commented Mar 31, 2021

What's the command for rendering the docs?

@diptorupd
Copy link
Copy Markdown
Contributor Author

diptorupd commented Mar 31, 2021

What's the command for rendering the docs?

In the README :)

@oleksandr-pavlyk
Copy link
Copy Markdown
Contributor

oleksandr-pavlyk commented Mar 31, 2021

Is this PR overlapping with #342 ?

@diptorupd
Copy link
Copy Markdown
Contributor Author

diptorupd commented Mar 31, 2021

Is this PR overlapping with #342 ?

I cherry picked 7adf124 out to reduce the shear number of files being changed in this PR.

@oleksandr-pavlyk
Copy link
Copy Markdown
Contributor

oleksandr-pavlyk commented Mar 31, 2021

You have to merge the master into this branch to see that reduction, I suppose.

@oleksandr-pavlyk
Copy link
Copy Markdown
Contributor

oleksandr-pavlyk commented Apr 1, 2021 •
edited
Loading

I installed doxyrest from conda-forge conda install conda-forge::doxyrest.

These errors seem like a problem with our sources (I merged master into this branch locally, may not have resolved all the conflicts the right way).

Generating group documentation...
/localdisk/work/opavlyk/repos/dpctl/dpctl-capi/include/dpctl_sycl_device_manager.h:46: warning: argument 'VRef' of command @param is not found in the argument list of DPCTL
DeviceVector_Delete(DPCTLDeviceVectorRef Ref)
/localdisk/work/opavlyk/repos/dpctl/dpctl-capi/include/dpctl_sycl_device_manager.h:46: warning: The following parameter of DPCTLDeviceVector_Delete(DPCTLDeviceVectorRef Ref
) is not documented:
  parameter 'Ref'
/localdisk/work/opavlyk/repos/dpctl/dpctl-capi/include/dpctl_sycl_platform_manager.h:44: warning: argument 'VRef' of command @param is not found in the argument list of DPC
TLPlatformVector_Delete(DPCTLPlatformVectorRef Ref)
/localdisk/work/opavlyk/repos/dpctl/dpctl-capi/include/dpctl_sycl_platform_manager.h:44: warning: The following parameter of DPCTLPlatformVector_Delete(DPCTLPlatformVectorR
ef Ref) is not documented:
  parameter 'Ref'

@oleksandr-pavlyk
Copy link
Copy Markdown
Contributor

oleksandr-pavlyk commented Apr 1, 2021 •
edited
Loading

I merge master into this branch, resolved conflicts and modified include/dpctl_vector.h to take care of quoted warnings.

See PR on your fork diptorupd#9

@diptorupd
Copy link
Copy Markdown
Contributor Author

diptorupd commented Apr 6, 2021 •
edited
Loading

@oleksandr-pavlyk @PokhodenkoSA I just bit the bullet and published the WIP docs.

The latest site is at : https://intelpython.github.io/dpctl/latest/index.html
0.6.1: https://intelpython.github.io/dpctl/0.6.1/index.html

But, it is a start.

@diptorupd diptorupd mentioned this pull request Apr 7, 2021
Merged
@diptorupd diptorupd force-pushed the doc-improvement branch 4 times, most recently from 437a438 to 4178d2f Compare April 18, 2021 04:20
Diptorup Deb added 7 commits April 17, 2021 23:27
dpCtl -> dpctl in all rst filenames.
294de13
Various fixes to C API doxygen comment strings.
a0a8b8b
Update the Python API rst.
3e1753f
Reorganize Python docs.
72f5533
Improvements to documentation build system.
954fc26 
  - Move to doxyrest for generating rest from doxygen
  - Rewrite CMakeLists to support generating docs with and
    without C API doc generation.
  - Minor changes to docstrings.
Reorganize rst files into a sub-folder.
738df28
Few more tweaks.
6aef253
@diptorupd diptorupd mentioned this pull request Apr 19, 2021
Merged
@diptorupd
Copy link
Copy Markdown
Contributor Author

diptorupd commented Apr 19, 2021

Closing in favour of #397

@diptorupd diptorupd closed this Apr 19, 2021
@diptorupd diptorupd deleted the doc-improvement branch May 1, 2021 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ndgrigorian ndgrigorian Awaiting requested review from ndgrigorian ndgrigorian will be requested when the pull request is marked ready for review ndgrigorian is a code owner

@antonwolfy antonwolfy Awaiting requested review from antonwolfy antonwolfy will be requested when the pull request is marked ready for review antonwolfy is a code owner

@vlad-perevezentsev vlad-perevezentsev Awaiting requested review from vlad-perevezentsev vlad-perevezentsev will be requested when the pull request is marked ready for review vlad-perevezentsev is a code owner

2 more reviewers

@PokhodenkoSA PokhodenkoSA PokhodenkoSA left review comments

@oleksandr-pavlyk oleksandr-pavlyk oleksandr-pavlyk left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@diptorupd diptorupd

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@diptorupd @oleksandr-pavlyk @PokhodenkoSA