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

C++ Client: documentation and sample code #1315

Merged
merged 4 commits into from
Oct 11, 2021

Conversation

kosak
Copy link
Contributor

@kosak kosak commented Sep 19, 2021

This is documentation and sample code for the C++ examples repo.

Notes:

  1. I actually don't think this pull request belongs in this repo. I think it belongs in some other cpp-examples repo, which may or may not have been created yet.
  2. The website named in the "intersphinx_mapping" clause needs to be updated

I've tested this documentation on Ubuntu 20.04 by doing the following:

$ sudo apt install doxygen flex bison cmake python python3-pip texlive-font-utils texlive-latex-extra texlive-extra-utils graphviz
# sphinx versions >= 4.1.0 don't like my variadic templates
$ pip install breathe sphinx==4.0.3 furo
$ cd cpp-client/doc
$ doxygen && sphinx-build -n . sphinxoutput
$ cd ../../cpp-examples/doc    # this repo
$ sphinx-build -n . sphinxoutput

Then I copy the first dir (cpp-client/doc/sphinxoutput) to my test website http://client.virtual-uk.com/
And I copy the second dir (cpp-examples/doc/sphinxoutput) to my other test website http://examples.virtual-uk.com/

And the second one links back to the first and it looks right.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 5, 2021

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@kosak
Copy link
Contributor Author

kosak commented Oct 5, 2021

recheck

@kosak
Copy link
Contributor Author

kosak commented Oct 5, 2021

I have read the CLA Document and I hereby sign the CLA

sphinx/sphinx.gradle Outdated Show resolved Hide resolved
sphinx/source/conf.py Show resolved Hide resolved
@kosak kosak force-pushed the kosak_cpp-examples branch 2 times, most recently from 25b6075 to ae86eb3 Compare October 6, 2021 21:56
@kosak
Copy link
Contributor Author

kosak commented Oct 6, 2021

recheck

@kosak
Copy link
Contributor Author

kosak commented Oct 6, 2021

OK, awesome. This looks like this works now. Thanks @niloc132.
Attention approvers (or @chipkent) : to make the make the merge happen I had to resolve a merge conflict in sphinx.gradle:

Chip had

pip3 install sphinx==3.5.4 [etc]

and we had it as

pip3 install sphinx==4.0.3 [etc]

so I kept 4.0.3. I'm not sure how much it matters which version we choose, so I just chose the later one.

@kosak
Copy link
Contributor Author

kosak commented Oct 6, 2021

Chip had

Re the above, nevermind @chipkent , that line was added by @niloc132.

jcferretti
jcferretti previously approved these changes Oct 6, 2021
Copy link
Member

@jcferretti jcferretti left a comment

Choose a reason for hiding this comment

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

Looked exclusively at the .gradle files, nothing more.

sphinx/sphinx.gradle Outdated Show resolved Hide resolved
sphinx/sphinx.gradle Outdated Show resolved Hide resolved
kosak and others added 3 commits October 11, 2021 14:22
 * cpp examples should have cpp client docs for objects.inv
 * correctly use a relative url for objects.inv and deployment
 * correctly copy cpp docs, not python
 * add todo, make dirs consistent
@jcferretti jcferretti merged commit be17a11 into deephaven:main Oct 11, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Oct 11, 2021
@kosak kosak deleted the kosak_cpp-examples branch July 25, 2022 22:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants