Scaffolding for C++ docs #185
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
mosra
added a commit
that referenced
this pull request
Sep 4, 2019
* Initial setup for C++ docs. * Set up crosslinking of Python and C++ docs. * Add at least some mainpage for C++ docs.
|
Forgot to switch the target branch to |
eundersander
pushed a commit
to eundersander/habitat-sim
that referenced
this pull request
Aug 6, 2020
Explicitly call close for vector env to avoid issues with file writer prematurely close buffer when tensorboard enabled. See facebookresearch#184 for more info.
Ram81
pushed a commit
to Ram81/habitat-web-sim
that referenced
this pull request
Dec 10, 2020
* Initial setup for C++ docs. * Set up crosslinking of Python and C++ docs. * Add at least some mainpage for C++ docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
Building on top of #71, this adds initial setup for C++ documentation generation 🎉
build_docs.shnow builds both C++ and Python docs (although the C++ docs produce a ton of warning about undocumented / misdocumented things -- lots of work to do there)How Has This Been Tested
Sample is at https://tmp.mosra.cz/habitat-cpp/. For example, this is how the newly added esp::gfx::RenderTarget from @erikwijmans in #114 looks like:
As usual, feedback is very appreciated -- and if you could try to pull this branch and run
./build_docs.shlocally, that'd be great.