Feature/doc infra improvements #397
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oleksandr-pavlyk
previously approved these changes
Apr 19, 2021
reazulhoque
reviewed
Apr 19, 2021
| To build using Python ``setuptools``, the following packages should be | ||
| installed: | ||
|
|
||
| - ``cython`` |
There was a problem hiding this comment.
Let us provide the specific versions of each of these dependencies if not a range of versions
There was a problem hiding this comment.
I will add a requirements.txt to our repo and reference that in the quick start guide.
added 5 commits
April 19, 2021 17:18
- Remove breathe and exhale requirements and instead use
Doxyrest for the C API documentation.
- Add cmake changes related to Doxyrest.
- Provide two separate modes of documentation generation:
both C and Python API and only Python API.
- Update README, gitignore.
- Changes name of all files to use dpctl instead of dpCtl. - Remove toc_pyapi.rst
- All Python API classes are now documented under separate
pages.
- Add an autosummary to each class documentation page.
- Rename dpCtl to dpctl in few places.
diptorupd
force-pushed
the
feature/doc-infra-improvements
branch
from
7ea7e4f to
0d61611
Compare
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Various improvements to dpctl documentation infrastructure.
doxyrestin place ofbreatheandexhaleto generate C API rst files.docfilessub-directory.Supersedes #341.