Skip to content
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

Updates to Python and C++ Docs #442

Merged
merged 12 commits into from
Jan 23, 2022

Conversation

cjnolet
Copy link
Member

@cjnolet cjnolet commented Jan 13, 2022

As we're beginning to hide the implementation details and establisht he public API, it's time to start putting a little focus on the presentation of our docs. Eventually, we want to make sure our different packages are easy to navigate and find. We will be updating this more as we continue to stabilize the public API.

The docs can be built by running ./build.sh docs from the repository root.

Closes #2

@cjnolet cjnolet added doc Documentation improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Jan 13, 2022
@cjnolet cjnolet requested review from a team as code owners January 13, 2022 20:45
@cjnolet cjnolet removed the improvement Improvement / enhancement to an existing function label Jan 13, 2022
Copy link
Member

@divyegala divyegala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one small comment, looks great otherwise

cpp/doxygen/main_page.md Outdated Show resolved Hide resolved
@cjnolet cjnolet changed the title Adding some content and styling to doxygen mainpage Updates to Python and C++ Docs Jan 14, 2022
@github-actions github-actions bot added the gpuCI label Jan 14, 2022
@cjnolet cjnolet requested a review from a team as a code owner January 14, 2022 22:00
Copy link
Member

@ajschmidt8 ajschmidt8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If these docs will eventually get published on our site, we'll need to add the breathe dependency to the rapids-doc-env below. @cjnolet, can you open a PR for that?

@cjnolet
Copy link
Member Author

cjnolet commented Jan 18, 2022

Absolutely, @ajschmidt8, I will do that.

Copy link
Member

@ajschmidt8 ajschmidt8 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving ops-codeowner changes now that rapidsai/integration#415 is merged.

@cjnolet
Copy link
Member Author

cjnolet commented Jan 23, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 4dca1f0 into rapidsai:branch-22.02 Jan 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CMake cpp doc Documentation gpuCI non-breaking Non-breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Start doc for RAFT "principals"
5 participants