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.

Sign up for GitHub

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

Jump to bottom

C++ API Docs webpage #3974

Closed
Tracked by #2919
Wumpf opened this issue Oct 24, 2023 · 1 comment
Closed
Tracked by #2919

C++ API Docs webpage #3974

Wumpf opened this issue Oct 24, 2023 · 1 comment
Assignees
@Wumpf
Labels
🌊 C++ API C/C++ API specific 📖 documentation Improvements or additions to documentation
Milestone
0.11

Comments

@Wumpf
Copy link
Member

Wumpf commented Oct 24, 2023 •
edited
Loading

Doxygen or similar. Ideally not Doxygen because out of the box it doesn't look all that great. There gotta be better ones out there by now
@Wumpf Wumpf mentioned this issue Oct 24, 2023
Closed
33 tasks
@Wumpf Wumpf changed the title from-doc-string generate documentation (likely doxygen) and link from website C++ API Docs webpage Oct 24, 2023
@emilk emilk added 📖 documentation Improvements or additions to documentation 🌊 C++ API C/C++ API specific labels Oct 24, 2023
@emilk emilk added this to the 0.11 C++ polish milestone Nov 1, 2023
@Wumpf Wumpf self-assigned this Nov 8, 2023
@Wumpf Wumpf mentioned this issue Nov 9, 2023
Merged
4 tasks
@Wumpf
Copy link
Member Author

Wumpf commented Nov 10, 2023

Left to do:

Wumpf added a commit that referenced this issue Nov 10, 2023
@Wumpf
C++ Doxygen documentation & many doc improvements (#4191)
8bff997 
### What

**Try it yourself:**
https://wumpf.github.io/rerun-cpp-doc-test/
(yes I sacrificed a repo for this ;))
Or to get a perfect up to date version now and in the future just run
`pixi run cpp-docs`, the docs appear then in
`rerun_cpp/docs/html/index.html`

* fixes _almost_ #3974
* Missing are:
   * process to upload it to landing and link it up in our docs
   * more thorough pass to improve docs overall
* lots of stuff is undocumented. We should consider making this an error
in doxygen (I disabled it for the time being!)

After some back and forth I landed with a pure doxygen documentation
using the impressively good
https://jothepro.github.io/doxygen-awesome-css/ css.
To avoid submoduling and make customization easy, the theme is embedded
in our repo.

Otherwise tons of improvements on our doc strings. Started a guide on
how to write docs similar to what we have for python.

Quite happy with it as-is already. Some of the doc improvements to be
done are also related to smaller code refactors I want to do :)

Review tip: The first commit contains the default doxygen file, if you
want to know what I changed about it just exclude it.

Bunch of screenshots for the lazy:

![image](https://github.com/rerun-io/rerun/assets/1220815/e603c1a4-07a9-4695-b9c7-d2980bb314fb)

![image](https://github.com/rerun-io/rerun/assets/1220815/ffe825ca-5d4a-499d-a6ae-e4dc50ac761f)

![image](https://github.com/rerun-io/rerun/assets/1220815/783846b1-e7cb-4a9a-8491-c5ab98499bd2)


### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/4191) (if
applicable)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG

- [PR Build Summary](https://build.rerun.io/pr/4191)
- [Docs
preview](https://rerun.io/preview/aa7c49ed49fe8fee18be914ccf604662143c7833/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/aa7c49ed49fe8fee18be914ccf604662143c7833/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
@Wumpf Wumpf mentioned this issue Nov 13, 2023
Merged
4 tasks
Wumpf added a commit that referenced this issue Nov 13, 2023
@Wumpf
C++ Doc improvements (#4212)
23a15b5 
### What

* Almost fixe_s #3974
* Follow-up of #4191

A few remaining items & polish for the C++ docs. Now uploaded to
gh-pages as well on push to main (🤞 it works.......)

Commit by commit!

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/4212) (if
applicable)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG

- [PR Build Summary](https://build.rerun.io/pr/4212)
- [Docs
preview](https://rerun.io/preview/4d098307e728ccea06f408df01f700dda18739c1/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/4d098307e728ccea06f408df01f700dda18739c1/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
@Wumpf Wumpf mentioned this issue Nov 13, 2023
Merged
4 tasks
Wumpf added a commit that referenced this issue Nov 15, 2023
@Wumpf
Add minimal examples in readme C++ api docs (#4217)
0be6185 
### What

* Another piece in the series of #3974 

Uses doxygen /snippet magic - this allows us to pick code out of a file
that we're otherwise compiling as part of the tests 🥳


![image](https://github.com/rerun-io/rerun/assets/1220815/1e369eb5-9e2d-42a1-9fc9-deb48b5dc572)


Also a few unrelated C++ doc fixes

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/4217) (if
applicable)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG

- [PR Build Summary](https://build.rerun.io/pr/4217)
- [Docs
preview](https://rerun.io/preview/04031671437f20feca904ffa815dace6d7fd73f7/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/04031671437f20feca904ffa815dace6d7fd73f7/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
@Wumpf Wumpf closed this as completed Nov 17, 2023
@teh-cmc teh-cmc mentioned this issue Dec 12, 2023
Closed
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Wumpf Wumpf

Labels
🌊 C++ API C/C++ API specific 📖 documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.11
Development

No branches or pull requests
2 participants
@emilk @Wumpf