Skip to content

Updates to Python and C++ Docs - #442

Merged
rapids-bot[bot] merged 12 commits into
NVIDIA:branch-22.02from
cjnolet:imp-2202_doxygen
Jan 23, 2022
Merged

rapids-bot[bot] merged 12 commits into
NVIDIA:branch-22.02from
cjnolet:imp-2202_doxygen

Conversation

@cjnolet

@cjnolet cjnolet commented Jan 13, 2022

Copy link
Copy Markdown
Contributor

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

@divyegala divyegala left a comment

Copy link
Copy Markdown
Contributor

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

Comment thread cpp/doxygen/main_page.md Outdated
@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

@ajschmidt8 ajschmidt8 left a comment

Copy link
Copy Markdown
Member

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

cjnolet commented Jan 18, 2022

Copy link
Copy Markdown
Contributor Author

Absolutely, @ajschmidt8, I will do that.

@ajschmidt8 ajschmidt8 left a comment

Copy link
Copy Markdown
Member

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

cjnolet commented Jan 23, 2022

Copy link
Copy Markdown
Contributor Author

@gpucibot merge

@rapids-bot
rapids-bot Bot merged commit 4dca1f0 into NVIDIA:branch-22.02 Jan 23, 2022
loulankxh pushed a commit to loulankxh/raft that referenced this pull request Oct 14, 2025
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 NVIDIA#2

Authors:
  - Corey J. Nolet (https://github.com/cjnolet)

Approvers:
  - Divye Gala (https://github.com/divyegala)
  - AJ Schmidt (https://github.com/ajschmidt8)
  - Brad Rees (https://github.com/BradReesWork)

URL: NVIDIA#442
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