Re:Marcel the Shell
by linsomniac on Tuesday October 24, 2023 @12:39AM
(#37994891)
Can I ask what you are using for the docs?
[ Parent
| on HN ]
For help documentation I wrote my own tool to format things the way I wanted for the console (e.g. colorized, adjusting to console width).
For the website, I'm using wix. I'm open to suggestions for using wix better, or choosing an alternative.
Re:Marcel the Shell
by linsomniac on Tuesday October 24, 2023 @11:24PM
(#38008794)
Oh, interesting, Wix wasn't even on my list for consideration. I like the look of it, but I also want to pull in some of my documentation from docstrings, possibly, so I think reStructuredText is a leading contender. That's what I'm getting ready to try setting up in my github workflow to see if I can get it to automatically format and publish the documentation to a github pages site.
I'm working on a not entirely dissimilar project (mine is focused more towards: fabric/ansible/cookiecutter type workflows, leaning on a lot of shell semantics. My workflows and hopefully soon documentation may be useful to you, I'd be happy to contribute them. I auto-build and publish releases to pypi. Project is: https://github.com/linsomniac/uplaybook