https://github.com/olorin37/doxtractor

Documentation extractor from any kind of sources files (WIP)
https://github.com/olorin37/doxtractor

doc documentation documentation-extractor documentation-toolchain extraction simple

Last synced: about 2 months ago
JSON representation

Documentation extractor from any kind of sources files (WIP)

• Host: GitHub
• URL: https://github.com/olorin37/doxtractor
• Owner: olorin37
• License: mit
• Created: 2019-11-12T22:40:15.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-30T22:27:26.000Z (5 months ago)
• Last Synced: 2025-02-05T08:49:06.044Z (4 months ago)
• Topics: doc, documentation, documentation-extractor, documentation-toolchain, extraction, simple
• Language: Awk
• Homepage:
• Size: 4.88 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Documentation extractor

===

_Work in progress..._

It is just about extract documentation strings from code and output them in gron

format. In scope of the `docex` is only this step. Documentation can be generated

like this:

```

awk -f docex.awk -v doc_prefix='##' example.sh \

  | gron --ungron \

  | jq -f format.jq > example.md

```