charlesdaniels / shelldoc Goto Github PK
View Code? Open in Web Editor NEWA tool for generating ReST documentation from shell scripts
License: BSD 3-Clause "New" or "Revised" License
A tool for generating ReST documentation from shell scripts
License: BSD 3-Clause "New" or "Revised" License
See commit d66c7ba
The new --prefix
feature cannot be adequately tested within the framework of do_test.sh
. I would propose adding an additional script to test this feature individually. In any case, it needs proper smoke testing.
Example:
... some code ...
# .INLINE
Some documentation which is directly pertinent to this code, but which also needs to wind up in the generated reST
# .ENDOC
... more code ...
The trouble lies in how exactly to handle .INLINE
type blocks, since if we wanted to just append the text to the top-level .SCRIPTDOC
segment, we would have to buffer the .SCRIPTDOC
segment in memory until EOF
is reached.
Alternatively, .INLINE
segments could be accumulated, concatenated, and added to the output after EOF
is reached, and thus displayed under a section header along the lines of "Further Notes".
This is the closest thing we have for of a convention for shell code comments. It would be cool if the parser could understand the syntax:
https://google.github.io/styleguide/shellguide.html#s4-comments
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.