-
Notifications
You must be signed in to change notification settings - Fork 374
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
docs: Allow producing a memray.1
man page
#524
Conversation
https://gist.github.com/godlygeek/e3ab347806010596cab9784ccc33f1a8 shows the memray.1 that's generated by running @alexmyczko Can you check if that man page meets your needs? It's more informative than what you propose in #523 and it shouldn't require too much more work to keep up to date. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #524 +/- ##
==========================================
- Coverage 92.37% 92.32% -0.06%
==========================================
Files 91 91
Lines 11270 11270
Branches 1571 1571
==========================================
- Hits 10411 10405 -6
- Misses 854 860 +6
Partials 5 5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Should we exercise this in CI in some way? At least to ensure that the manual page can be generated and isn't empty for example. |
Yes, let's.
I'll make sure it's generated. I'm not gonna check for emptiness - we don't do that for the HTML output, so doing it for the man output seems superflous. But I will update Let's not worry about the "empty output" case unless we ever find a case where Sphinx generates an empty file and returns a success rcode to us. 😃 |
This man page will contain a small bit of prose explaining what Memray is and where to find the full documentation, followed by CLI usage information scraped from the `--help` of each of our subcommands. Distros can build the man page for any given version to include in distro packages of Memray. Signed-off-by: Matt Wozniski <mwozniski@bloomberg.net>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This man page will contain a small bit of prose explaining what Memray is and where to find the full documentation, followed by CLI usage information scraped from the
--help
of each of our subcommands. Distros can build the man page for any given version to include in distro packages of Memray.