Add brief section on documenting other languages to tutorial #9850
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
jakobandersen
requested changes
Nov 18, 2021
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
|
Thanks both! Applied all the suggestions |
jakobandersen
approved these changes
Nov 19, 2021
|
Merging. Good work! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Short follow-up to #9534 (comment), where it was discussed that it would be good to expand on the Sphinx capabilities of documenting other languages.
It sort of deviates from the main tutorial in that it doesn't add any C++ code to the supposed documentation of Lumache, but I hope it serves at least for clarifying that Sphinx is capable of much more than just documenting Python objects.
cc @tk0miya @jakobandersen