Publish Developer Guide #673

harrism · 2022-09-14T10:32:15Z

Description

This PR mimics rapidsai/cudf#11475 to add libcuspatial's C++ developer guide to the rendered Doxygen HTML docs. See that PR for detailed discussion.

Contributes to #598 . Closes #235

Note that this PR depends on #672 and #667 so the changed files will include changes from those PRs until they are merged.

Checklist

I am familiar with the Contributing Guidelines.
New or existing tests cover these changes.
The documentation is up to date with these changes.

ajschmidt8 · 2022-09-20T13:18:05Z

ci/release/update-version.sh

+sed_runner "s|\(TAGFILES.*librmm/\).*|\1${NEXT_SHORT_TAG}|" cpp/doxygen/Doxyfile
+sed_runner "s|\(TAGFILES.*libcudf/\).*|\1${NEXT_SHORT_TAG}|" cpp/doxygen/Doxyfile


Suggested change

sed_runner "s|$TAGFILES.*librmm/$.*|\1${NEXT_SHORT_TAG}|" cpp/doxygen/Doxyfile

sed_runner "s|$TAGFILES.*libcudf/$.*|\1${NEXT_SHORT_TAG}|" cpp/doxygen/Doxyfile

sed_runner "/TAGFILES/ s|[0-9]\+.[0-9]\+|${NEXT_SHORT_TAG}|g" cpp/doxygen/Doxyfile

The original changes here didn't work for me when I tested them locally. This suggested change seems to do the trick. You can verify this locally by running bash ci/release/update-version.sh 22.10.00 and verifying the results.

cpp/doxygen/developer_guide/BENCHMARKING.md

cpp/doxygen/developer_guide/DOCUMENTATION.md

thomcom · 2022-09-20T20:50:01Z

cpp/doxygen/developer_guide/DOCUMENTATION.md

+| \@defgroup | For use only in [doxygen_groups.h](../include/doxygen_groups.h) and should include the group's title. |
+| \@ingroup | Use inside individual doxygen block comments for declaration statements in a header file. |
+| \@addtogroup | Use instead of \@ingroup for multiple declarations in the same file within a namespace declaration. Do not specify a group title. |
+| `@{ ... @}` |  Use only with \@addtogroup. |


I think a list of the groups in doxygen_groups.h and their purpose might be appropriate here. Or a link to it telling the user to go read them.

vyasr

I just focused on reviewing the changes to doxygen files and the associated scripts. Everything there looks fine, and the link added to the DEVELOPER_GUIDE.md should be sufficient for the built documentation to render appropriately. Probably worth trying to build locally once (in case you haven't yet) just to be sure, but I think this looks good.

Co-authored-by: H. Thomson Comer <thomcom@gmail.com>

…atial into fea-publish-developer-guide

ajschmidt8 · 2022-09-27T17:25:10Z

ci/release/update-version.sh

@@ -45,3 +45,7 @@ sed_runner 's/'"branch-.*\/RAPIDS.cmake"'/'"branch-${NEXT_SHORT_TAG}\/RAPIDS.cma
 for FILE in conda/environments/*.yml; do
  sed_runner "s/cudf=${CURRENT_SHORT_TAG}/cudf=${NEXT_SHORT_TAG}/g" ${FILE};
 done
+
+# Doxyfile update
+sed_runner "/PROJECT_NUMBER/ s|[0-9]\+.[0-9]\+|${NEXT_SHORT_TAG}|g" cpp/doxygen/Doxyfile


Suggested change

sed_runner "/PROJECT_NUMBER/ s|[0-9]\+.[0-9]\+|${NEXT_SHORT_TAG}|g" cpp/doxygen/Doxyfile

sed_runner "/PROJECT_NUMBER[ ]*=/ s|=.*|= ${NEXT_FULL_TAG}|g" cpp/doxygen/Doxyfile

One more update needed here. You can test this with various version numbers to ensure that everything works as intended. For example, run the following and check the diff each time.

bash ci/release/update-version.sh 22.12.00 bash ci/release/update-version.sh 22.12.02

harrism · 2022-09-28T01:37:40Z

rerun tests

harrism · 2022-09-28T12:01:01Z

Depends on #667

#700) This PR fixes some render issue with `library_design.md`, adds links to c++ documentation (maybe changed after merging [673](#673)) Authors: - Michael Wang (https://github.com/isVoid) Approvers: - H. Thomson Comer (https://github.com/thomcom) - Mark Harris (https://github.com/harrism) URL: #700

harrism · 2022-09-29T21:51:17Z

Rerun tests

isVoid

Sorry late to the game, all looks good. Using modify_fences.sh to allow proper display in both github and published doxygen certainly is an interesting technique.

cpp/doxygen/developer_guide/DOCUMENTATION.md

isVoid · 2022-09-30T18:37:42Z

@gpucibot merge

harrism added 13 commits September 7, 2022 16:16

Add DOCUMENTATION.md

8dc1ecb

Add testing.md

03eeb9d

Simplify

f003154

Add BENCHMARKING.md

994d401

Move developer guide docs

5f7236d

rename refactoring guide.

f1666e0

Add layout that links to developer guide.

814beef

Remove code font from headers

84bfaa0

Missed one.

dfc93ec

Merge branch 'fea-documentation-md' into fea-publish-developer-guide

36f0105

Move documentation and escape @ commands.

a1b379d

Remove <a> links

d354e01

Add REFACTORING_GUIDE

97bcfa2

harrism added 3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change labels Sep 14, 2022

harrism requested a review from vyasr September 14, 2022 10:32

harrism requested a review from a team as a code owner September 14, 2022 10:32

harrism self-assigned this Sep 14, 2022

harrism requested a review from zhangjianting September 14, 2022 10:32

github-actions bot added the libcuspatial Relates to the cuSpatial C++ library label Sep 14, 2022

harrism requested review from thomcom and isVoid and removed request for zhangjianting September 20, 2022 01:57

Add sed command to update tagfile versions in Doxyfile.

a22769f

harrism requested a review from a team as a code owner September 20, 2022 04:24

github-actions bot added the gpuCI Related to Continuous Integration / Automation label Sep 20, 2022

harrism mentioned this pull request Sep 20, 2022

Add DOCUMENTATION.md #667

Merged

3 tasks

ajschmidt8 requested changes Sep 20, 2022

View reviewed changes

thomcom approved these changes Sep 20, 2022

View reviewed changes

vyasr approved these changes Sep 20, 2022

View reviewed changes

harrism and others added 4 commits September 21, 2022 11:36

Apply suggestions from code review

66ee41f

Co-authored-by: H. Thomson Comer <thomcom@gmail.com>

Fix update_version.sh

93c1eea

Link to groups.

9a48170

Merge branch 'fea-publish-developer-guide' of github.com:harrism/cusp…

79a8abb

…atial into fea-publish-developer-guide

harrism requested a review from ajschmidt8 September 27, 2022 05:03

ajschmidt8 reviewed Sep 27, 2022

View reviewed changes

Fix PROJECT_NUMBER update in update_version.sh

85b611e

ajschmidt8 approved these changes Sep 27, 2022

View reviewed changes

harrism added 5- Merge After Dependencies and removed 3 - Ready for Review Ready for review by team labels Sep 28, 2022

isVoid mentioned this pull request Sep 28, 2022

Add C++ doc links to library_design.md and minor documentation fixes #700

Merged

3 tasks

harrism added 3 commits September 29, 2022 09:49

Merge branch 'branch-22.10' into fea-publish-developer-guide

994b8a5

Copy changes made to old files, and delete old files.

f6434b8

cudf --> cuspatial

cace8e9

harrism added this to the Developer Documentation milestone Sep 29, 2022

Improve main_page.md with description and links.

e8a8912

isVoid approved these changes Sep 30, 2022

View reviewed changes

cpp/doxygen/developer_guide/DOCUMENTATION.md Show resolved Hide resolved

isVoid added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 5- Merge After Dependencies labels Sep 30, 2022

rapids-bot bot merged commit ba50335 into rapidsai:branch-22.10 Sep 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Publish Developer Guide #673

Publish Developer Guide #673

harrism commented Sep 14, 2022 •

edited

Loading

ajschmidt8 Sep 20, 2022

thomcom Sep 20, 2022

harrism Sep 27, 2022

vyasr left a comment

ajschmidt8 Sep 27, 2022

harrism commented Sep 28, 2022

harrism commented Sep 28, 2022

harrism commented Sep 29, 2022

isVoid left a comment

isVoid commented Sep 30, 2022

		sed_runner "s\|\(TAGFILES.librmm/\).\|\1${NEXT_SHORT_TAG}\|" cpp/doxygen/Doxyfile
		sed_runner "s\|\(TAGFILES.libcudf/\).\|\1${NEXT_SHORT_TAG}\|" cpp/doxygen/Doxyfile

	sed_runner "s\|\(TAGFILES.librmm/\).\|\1${NEXT_SHORT_TAG}\|" cpp/doxygen/Doxyfile
	sed_runner "s\|\(TAGFILES.libcudf/\).\|\1${NEXT_SHORT_TAG}\|" cpp/doxygen/Doxyfile
	sed_runner "/TAGFILES/ s\|[0-9]\+.[0-9]\+\|${NEXT_SHORT_TAG}\|g" cpp/doxygen/Doxyfile

	sed_runner "/PROJECT_NUMBER/ s\|[0-9]\+.[0-9]\+\|${NEXT_SHORT_TAG}\|g" cpp/doxygen/Doxyfile
	sed_runner "/PROJECT_NUMBER[ ]=/ s\|=.\|= ${NEXT_FULL_TAG}\|g" cpp/doxygen/Doxyfile

Publish Developer Guide #673

Publish Developer Guide #673

Conversation

harrism commented Sep 14, 2022 • edited Loading

Description

Checklist

ajschmidt8 Sep 20, 2022

Choose a reason for hiding this comment

thomcom Sep 20, 2022

Choose a reason for hiding this comment

harrism Sep 27, 2022

Choose a reason for hiding this comment

vyasr left a comment

Choose a reason for hiding this comment

ajschmidt8 Sep 27, 2022

Choose a reason for hiding this comment

harrism commented Sep 28, 2022

harrism commented Sep 28, 2022

harrism commented Sep 29, 2022

isVoid left a comment

Choose a reason for hiding this comment

isVoid commented Sep 30, 2022

harrism commented Sep 14, 2022 •

edited

Loading