4 ms·
What I need is a sensible kit of software to let me generate API documentation without the opinions on, "this is actually a web server to be hosted". I just wan
by Waterluvian 7y ago
What I need is a sensible kit of software to let me generate API documentation without the opinions on, "this is actually a web server to be hosted". I just want markdown or HTML outputs without "Try it now!" or other features.
But I also don't want to hand-roll my docs by just writing Sphinx. I like the "provide a schema definition then supplement with hand-written docs and customization" approach.
- Nijikokun 7y agoWe've been discussing this internally quite a bit and is something we want to provide through our plugin infrastructure which is the ability to choose the type of specification, it's output and preview mechanisms. This way the workflow can be specialized for your needs.
- martinni 7y agoHave you looked into protobuf? Seems like it should do the trick