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

Documentation: create man pages for ami commands #16

Open
remkop opened this issue Mar 31, 2020 · 1 comment
Open

Documentation: create man pages for ami commands #16

remkop opened this issue Mar 31, 2020 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@remkop
Copy link
Collaborator

remkop commented Mar 31, 2020

Background

The ami toolset is used in the https://github.com/petermr/openVirus project to convert scientific papers from PDF and other formats into machine-readable and searchable formats. The toolset is very large, being the result of many years of work; we want to make it more accessible and lower the learning curve for collaborators.

Proposed Change

I propose that we add a step to the Maven build to generate man pages (in unix man page format and HTML). Picocli can auto-generate AsciiDoc pages for all picocli commands; these pages can then be converted to various other formats with the AsciiDoctor tool.

TBD: should the generated HTML pages be hosted somewhere in the ami3 project for easy reference?

Benefits

Make it easier for ami users to find commands that meet their needs, and how to use these commands.

Man page documentation can be generated automatically for all commands.

Drawbacks

Adds dependencies to the project and complicates the build.

@remkop remkop added the documentation Improvements or additions to documentation label Apr 6, 2020
@remkop remkop self-assigned this Apr 7, 2020
@remkop
Copy link
Collaborator Author

remkop commented Apr 13, 2020

Also, as mentioned in #15, the usage help message for all ami commands should show runnable examples.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant