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

add xref for subcommands #1340

Merged
merged 1 commit into from
Mar 5, 2021
Merged

add xref for subcommands #1340

merged 1 commit into from
Mar 5, 2021

Conversation

crotwell
Copy link
Contributor

@crotwell crotwell commented Mar 4, 2021

subcommands get separate html files, nice if html generated from asciidoc could link them.

Added an xref for each subcommand and updated tests. I believe an xref like this doesn't hurt anything, and helps with linking is possible (html and pdf). That said, I know just enough asciidoc to be dangerous, so...

@codecov
Copy link

codecov bot commented Mar 4, 2021

Codecov Report

Merging #1340 (b328ed4) into master (0c5a971) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #1340   +/-   ##
=========================================
  Coverage     93.76%   93.76%           
  Complexity      474      474           
=========================================
  Files             2        2           
  Lines          6961     6961           
  Branches       1869     1869           
=========================================
  Hits           6527     6527           
  Misses          147      147           
  Partials        287      287           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0c5a971...b328ed4. Read the comment docs.

@remkop remkop added theme: codegen An issue or change related to the picocli-codegen module type: enhancement ✨ labels Mar 5, 2021
@remkop remkop added this to the 4.6.2 milestone Mar 5, 2021
@remkop remkop merged commit 45e6869 into remkop:master Mar 5, 2021
@remkop
Copy link
Owner

remkop commented Mar 5, 2021

Merged.
Thank you for the contribution! I really like this, and suspect there are many other parts of the document that can be linked this way. For example:

  • provide a link to the parent command (maybe from the synopsis)
  • provide links to the options from the synopsis
  • ... other ideas?

Also related to #1227 in the sense of improving usability of the generated manpage docs.

@crotwell crotwell deleted the link-subcommands branch July 2, 2021 16:15
MarkoMackic pushed a commit to MarkoMackic/picocli that referenced this pull request Oct 17, 2021
MarkoMackic added a commit to MarkoMackic/picocli that referenced this pull request Oct 17, 2021
MarkoMackic added a commit to MarkoMackic/picocli that referenced this pull request Oct 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme: codegen An issue or change related to the picocli-codegen module type: enhancement ✨
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants