Open
Description
Several aspects of dpctl documentation need to be improved. This ticket collects everything that needs to be cleaned up.
- Missing user guides
- Device selection
- Event profiling
- Queue profiling
- Creating different types of queues
- Sub-devices
- Add examples to Python API functions and add them to docstrings
- Fix and improve C API docstrings
- Improve the overview
- Missing Python docstrings
- Inconsistent styling between C API and Python API
- Broken links in C API
- Missing examples in Python API
- Missing programming guide for C API (mention PIMPL, pointer ownership macros, organization of modules, etc.)
- Fix support for multi-version links in the sidebar. Currently we are using an hard coded value to our github.io site. Can we use a cleaner solution e.g. using
sphinx-multiversion
? - Copyright year should not be hard-coded.