Eric, are you saying you never want to write RST anymore? me neither. yuck!
On Tue, Feb 20, 2018 at 9:57 AM, Eric Friedrich (efriedri) <
efrie...@cisco.com> wrote:
> Is it possible to take the swagger generated documentation and have that
> automatically included in the read-the-docs site?
>
>
Eric: Out of curiosity I was able to generate it with the tooling I
mentioned here:
https://github.com/dewrich/incubator-trafficcontrol/blob/swagger-demo/traffic_ops/traffic_ops_golang/docs/swagger.rst
-Dew
On Tue, Feb 20, 2018 at 10:38 AM, Dewayne Richardson
wrote:
> Yes
Yes the plan was to get the initial thumbs up, then figure out how we can
deploy it (by default swagger generates interactive, meaning it needs a
server, UI doc). A quick internet search says there does look like tooling
for converting swagger docs to .rst (
Is it possible to take the swagger generated documentation and have that
automatically included in the read-the-docs site?
Asked another way: Can swagger generate docs in ReStructed Text (.rst) format?
—Eric
> On Feb 20, 2018, at 11:38 AM, Dave Neuman wrote:
>
> Sounds
Sounds good. I look forward to seeing it merged into our repo.
I guess this means there will need to be a PR to remove our current API
docs as they get moved to swagger.
On Tue, Feb 20, 2018 at 8:40 AM, Jeremy Mitchell
wrote:
> I think this all sounds very promising.
I think this all sounds very promising. Some advantages that I see are:
- docs never drift from API implementation (currently our docs get out of
sync real fast)
- this provides yet another interface -
https://app.swaggerhub.com/apis/dewrich/traffic-ops_api/1.3 - (in addition
to TP) to interact