update docgen documentation #18192
Merged
update docgen documentation #18192
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
timotheecour
reviewed
Jun 5, 2021
timotheecour
reviewed
Jun 5, 2021
doc/docgen.rst
Outdated
| =================== ====================== ============ ============== | ||
| `nim doc`:cmd: documentation comments ``.nim`` ``.html`` HTML | ||
| `nim doc2tex`:cmd: \` \` ``.tex`` LaTeX | ||
| `nim jsondoc`:cmd: \` \` ``.json`` JSON |
There was a problem hiding this comment.
how about (in this or future PR) change this to doc2json for consistency (and making jsondoc an undocumented alias to it)
There was a problem hiding this comment.
but if you push this logic than doc2html shall be introduced instead of doc.
timotheecour
reviewed
Jun 5, 2021
timotheecour
reviewed
Jun 5, 2021
timotheecour
reviewed
Jun 5, 2021
timotheecour
reviewed
Jun 5, 2021
Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
PMunch
pushed a commit
to PMunch/Nim
that referenced
this pull request
Mar 28, 2022
* update docgen documentation * --fullhelp * Update doc/docgen.rst Co-authored-by: Timothee Cour <timothee.cour2@gmail.com> * [skip ci] fix typos Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
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.
Mentions
doc2texin Changelog anddocgen.rst(for #17997 and #18141).Fix a few typos/anachronisms in
docgen.rst.