TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Show HN: Parse2docs, turn Python Argparsers into usage documentation

14 pointsby brauhausalmost 2 years ago

2 comments

brauhausalmost 2 years ago
This is the first person library I&#x27;ve published! :)<p>I was getting tired of creating command line interfaces in Python whose contents I would then copy to create the Usage documentation. Now I pass the path to the script the ArgumentParser is located and it generates the markdown for me.<p>Currently, it can only find parsers located either in the module scope out that are returned by a function.<p>It doesn&#x27;t handle subparsers yet, but I&#x27;m thinking about leaving like that for now. As of next steps, I wanted to add an option to generate docs in .rst format or wrap the library as a plugin for mkdocs.<p>I&#x27;m here for all feedback - bugs, feature suggestions, and usability comments. You can comment, open a GitHub issue, or reach out directly.<p>Ofc, I&#x27;m also welcoming any contributions. Please test parse2docs and send me your suggestions!
musicalealmost 2 years ago
There&#x27;s also help2man, which turns help output into man pages.
评论 #36642359 未加载