Skip to content

Sphinx and Doxygen documentation #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 25 commits into from
Nov 2, 2020

Conversation

diptorupd
Copy link
Contributor

Adds an initial infrastructure to generate API documentation. Documentation generation works fine locally. Tried publishing them on gh-pages with not so great results.

I think Sphix+breathe+exhale+doxygen works much nicer than raw doxygen. Although, some information that is on doxygen is not showing up in sphinx using exhale and breathe.

Checkout xtensor documentation to see a more polished example than what I have managed to do thus far using breathe and exhale.

Diptorup Deb added 3 commits October 9, 2020 18:50
    - Fix sphinx code generation bug
    - Add a temporary link to the raw doxygen files in index.rst
@diptorupd
Copy link
Contributor Author

Pushed the static pages to gh-pages. You can see them rendered here https://intelpython.github.io/dpctl/. Somehow they render incorrectly.

@oleksandr-pavlyk
Copy link
Contributor

Trying to compile with build_for_develop, I encountered:

CMake Error at CMakeLists.txt:192 (add_subdirectory):
  add_subdirectory given source "docs" which is not an existing directory.


-- Configuring incomplete, errors occurred!

@PokhodenkoSA
Copy link
Contributor

Pushed the static pages to gh-pages. You can see them rendered here https://intelpython.github.io/dpctl/. Somehow they render incorrectly.

I would like to propose URL like for SDC and add -doc suffix: https://intelpython.github.io/dpctl-doc/

@Alexander-Makaryev what are URLs for dpNP and daal4py?

@PokhodenkoSA
Copy link
Contributor

Resolved merge conflict:

  1. Formatted with black - master is black formatted
  2. Merged with master

@PokhodenkoSA
Copy link
Contributor

PokhodenkoSA commented Oct 20, 2020

I have fixed incorrect rendering. Just created .nojekyll file. See this commit 99e7f9b and its commit message.

@diptorupd
Copy link
Contributor Author

@oleksandr-pavlyk Can you review the PR once more? I have fixed the CMakeLists.txt issue you found. I will like to merge this as the first step to making generating docs easier.

@diptorupd
Copy link
Contributor Author

@oleksandr-pavlyk Actually let me move the changes to backends\CMakeLists.txt and sycl_core.pyx out of the PR.

@PokhodenkoSA PokhodenkoSA mentioned this pull request Nov 2, 2020
@diptorupd
Copy link
Contributor Author

@oleksandr-pavlyk Can you please review the changes I made to the Cython files to add __all__? I will like to merge this PR as it makes generating docs much easier.

Copy link
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.

LGTM.

@diptorupd diptorupd merged commit 092e00c into IntelPython:master Nov 2, 2020
@diptorupd diptorupd deleted the feature/doc-gen branch November 2, 2020 19:35
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