https://github.com/kineticcookie/archivarius

Documentation renderer based on sbt-paradox
https://github.com/kineticcookie/archivarius

markdown openapi protobuf work-in-progress

Last synced: 11 months ago
JSON representation

Documentation renderer based on sbt-paradox

• Host: GitHub
• URL: https://github.com/kineticcookie/archivarius
• Owner: KineticCookie
• Created: 2020-04-05T09:58:15.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2020-04-05T14:18:52.000Z (almost 6 years ago)
• Last Synced: 2025-01-26T20:47:16.491Z (about 1 year ago)
• Topics: markdown, openapi, protobuf, work-in-progress
• Language: Scala
• Homepage:
• Size: 83 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.MD

Awesome Lists containing this project

README

          
# Archivarius

The documentation renderer based on [sbt-paradox](https://github.com/lightbend/paradox).

Since it's not supported anymore I decided to migrate it to scala 2.13 and improve by adding

new directives.

## Parsing proto schema

### Get ast from proto files

pwd is hydro-serving-protos repository

```

docker run -it --entrypoint bash \

  -v $(pwd)/doc:/out \

  -v $(pwd)/src/:/protos \

  pseudomuto/protoc-gen-doc

protoc --doc_out=/out --doc_opt=json,docs.json:hydro_serving_grpc/onnx/ $(find . -name '*.proto') 2> /out/warnings.txt

```