Skip to content

Sphinx updates#3468

Merged
rapids-bot[bot] merged 12 commits intorapidsai:branch-23.06from
BradReesWork:fixing_sphinx_errors
Apr 13, 2023
Merged

Sphinx updates#3468
rapids-bot[bot] merged 12 commits intorapidsai:branch-23.06from
BradReesWork:fixing_sphinx_errors

Conversation

@BradReesWork
Copy link
Member

Spinx is very picky and looks for indentations and black lines. Also during the build, if there is an error, Spinx just ignores the function that caused the error rather to terminating the build.

Some docstrings also used reserved character {* and _} which are used for formating

This PR:

addresses Spinx Warnings and Errors
addresses issues where rst is md is not added to the output
any any other issues

You will see a lot of additional blank lines added and some text clean-up for readability.

Seems like the PR also picked up all the the 23.06 updates - so half the files are not really for this PR

@BradReesWork BradReesWork requested review from a team as code owners April 11, 2023 13:15
@BradReesWork BradReesWork marked this pull request as draft April 11, 2023 13:15
@ajschmidt8
Copy link
Member

@BradReesWork, in other repositories that didn't have a lot of sphinx warnings, we used the -W flag to treat warnings as errors:

It's probably worth adding that to cugraph's ci/build_docs.sh file as well.

@BradReesWork BradReesWork added doc Documentation non-breaking Non-breaking change labels Apr 11, 2023
@BradReesWork BradReesWork self-assigned this Apr 11, 2023
@BradReesWork BradReesWork marked this pull request as ready for review April 11, 2023 16:32
Copy link
Contributor

@acostadon acostadon left a comment

Choose a reason for hiding this comment

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

Looks good to me

@BradReesWork
Copy link
Member Author

@ajschmidt8 I do use the "-W" flag when I'm debugging. There are still a large number of improvements that need to be finished before the code is ready for that flag - but by the end of this release it should be turned on

Copy link
Contributor

@rlratzel rlratzel left a comment

Choose a reason for hiding this comment

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

Looks good. I'm approving and this can be merged, but I do have a question which could result in a change based on what you think.

@rlratzel
Copy link
Contributor

/merge

@rapids-bot rapids-bot bot merged commit fbef6f7 into rapidsai:branch-23.06 Apr 13, 2023
>>>
>>> distances, predecessors, vertices = res
>>>
f>>> inal_results = cudf.DataFrame({
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo?

>>> final_results = cudf.DataFrame({

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants