Overhaul of dpctl documentation - #1619

Merged

oleksandr-pavlyk merged 58 commits into

docstring-edits

Apr 17, 2024

Commits on Apr 11, 2024

Checking in new documentation in doc_sources/
oleksandr-pavlyk
committed
41a428f
Moved old doc sources into _legacy
oleksandr-pavlyk
committed
141c476
Changed cmake script to build from new sources
oleksandr-pavlyk
committed
219dd24
Make sure needed doc dependencies are installed
oleksandr-pavlyk
committed
a2329f6
Added code to add extensions if using DoxyRest
oleksandr-pavlyk
committed
4549c97
Do not use @{u}, it does not work in detached state
oleksandr-pavlyk
committed
9cc975d
Doxyrest should document empty defines (to document __dpctl_give, etc)
oleksandr-pavlyk
committed
0139ceb
Adds page for linear algebra functions to `dpctl.tensor` documentation
ndgrigorian
authored and
oleksandr-pavlyk
committed
da20e6a
Corrected example extension compilation command
oleksandr-pavlyk
committed
29cf4e5
Fix typo found by @vtavana
oleksandr-pavlyk
committed
78184a4
Added section about default data types, and type promotion
oleksandr-pavlyk
committed
aefd2fc
Expanded environment variable document
oleksandr-pavlyk
committed
d8c7461
Added a label to be able to refer to an example
oleksandr-pavlyk
committed
f8a7f85
Utility function lists allclose, and Device object
oleksandr-pavlyk
committed
8569c64
Initial write-up of introduction to tensor
oleksandr-pavlyk
committed
534ffa6
Addressed issues pointed out by @vtavana
oleksandr-pavlyk
committed
73a2885
Fix underline is too short sphinx warning
oleksandr-pavlyk
committed
c47e3dd
Populated more of tensor_intro document
oleksandr-pavlyk
committed
83e4983
Add .gitignore to reference_guide/libsyclinterface/generated
oleksandr-pavlyk
committed
7461d01
Replaced reference_guide/libsyclinterface/generated/index.rst
oleksandr-pavlyk
committed
2b250dd
Applied edits @ndgrigorian suggested in review
oleksandr-pavlyk
committed
afedd46
Applied review changes suggested by @ndgrigorian
oleksandr-pavlyk
committed
6c9be75
Renamed Reference Guides to API Reference, added dpctl_cmake
oleksandr-pavlyk
committed
27facfd
Expand dpctl_cmake.rst
oleksandr-pavlyk
committed
34ccfe8
Edits to api_reference index listing order
oleksandr-pavlyk
committed
f3dccbc
Added document about DLPack
oleksandr-pavlyk
committed
db0ff0f
Moved why is it called dpctl out of installation sub-section
oleksandr-pavlyk
committed
e41b3b7
Remove unsed label causing warnings
oleksandr-pavlyk
committed
863863a
Generate page for dpctl.get_include()
oleksandr-pavlyk
committed
d24b2c6
Reference dpctl_cmake in hidden toctree
oleksandr-pavlyk
committed
067ccfb
Added few more templates, made them generate pages for attributes and methods of Cython classes
oleksandr-pavlyk
committed
3c1fa04
Use cython_class template for SyclDevice, etc.
oleksandr-pavlyk
committed
d31844c
Use cython_class template for usm_ndarray
oleksandr-pavlyk
committed
7545dcc
Omit __init__ entry in usmmemory template
oleksandr-pavlyk
committed
f37e059
Restore label for to_device example, but in the parent document, not in the included one
oleksandr-pavlyk
committed
87a7e8f
Use usm_ndarray template for documenting array object class
oleksandr-pavlyk
committed
f0ed81c
Add special attributes to usm_ndarray template
oleksandr-pavlyk
committed
6108936
Add logo SVG file
oleksandr-pavlyk
committed
db2c3bf
Use logo, switch pygment style to default, strip sha from version
oleksandr-pavlyk
committed
e111c8f
State that DPC++ supports SYCL 2020 spec
oleksandr-pavlyk
committed
5fd500c
Fixed wordings, added hyperlinks to extension generators
oleksandr-pavlyk
committed
6c7ec98
Use sphinx_copybutton
oleksandr-pavlyk
committed
31c98a8
Workflow to install sphinx-copybutton
oleksandr-pavlyk
committed
79934ca
Set copybutton_prompt_text as appropriate for default Python shell
oleksandr-pavlyk
committed
ed07e5b
Use verbose cmake mode for genderate-docs
oleksandr-pavlyk
committed
420f17b
Use cython_class template for inspect class to generate pages for methods
oleksandr-pavlyk
committed
b93d72f
Renamed documents in beginners guide in preparation for refactoring
oleksandr-pavlyk
committed
e967319
Rewrite of installation guide to consolidate it into one page.
oleksandr-pavlyk
committed
b11bf0c

Commits on Apr 12, 2024

Commits on Apr 15, 2024

Consolidated many pages into "Heterogenous Systems and Programming Concepts"
oleksandr-pavlyk
committed
1f1dd09

Commits on Apr 16, 2024

Expanded tensor_intro to cover moving data between host and device
oleksandr-pavlyk
committed
51df933

Commits on Apr 17, 2024

Using sphinxcontrib.spelling as extension
oleksandr-pavlyk
committed
ee22e70
Spelling fixes
oleksandr-pavlyk
committed
175eba8
Reworded no longer accurate statement that spell-checker prompted to look at
oleksandr-pavlyk
committed
a1093d9
Typos found by @ndigrigorian
oleksandr-pavlyk
committed
b7d9515
Writeable->writable
oleksandr-pavlyk
committed
b9fb29f
Fixed typo, added more known-as-spelled-correctly words
oleksandr-pavlyk
committed
1abd650