Top 7.0% forks on proxy.golang.org
proxy.golang.org : github.com/joeshaw/rst-extract
The rst-extract utility extracts reStructured Text (RST) from Go source comments tagged with the special token "+rst" in the first line. Usage: rst-extract <source dir> <output dir> where "source dir" is a directory containing Go source files ending in .go, and "output dir" is a directory to output .rst files. rst-extract will create one .rst file per package. The source files are processed in a predictable order: (1) a file name matching the package name (for instance, "main.go" in a "main" package); (2) "doc.go"; and (3) lexicographic order. Comments within a file are processed in the order they appear. This predictable ordering allows you to add, for instance, a header to the output RST file by adding it to one of the special cases that are processed first.
Registry
-
Source
- Documentation
- JSON
purl: pkg:golang/github.com/joeshaw/rst-extract
Keywords:
golang
, rst
, sphinx
License: MIT
Latest release: over 7 years ago
First release: over 7 years ago
Namespace: github.com/joeshaw
Stars: 5 on GitHub
Forks: 1 on GitHub
See more repository details: repos.ecosyste.ms
Last synced: 2 months ago