search

opendcs / rest_api

Rest API that serves OpenDCS database objects as JSON
Apache License 2.0
1 stars 3 forks source link

Move documentation out of word doc and into the OpenAPI and ReadTheDocs #100

Open adamkorynta opened 9 months ago

adamkorynta commented 9 months ago

Component to be refactored restapi.docx with initial documentation on the repository.

Purpose of refactoring Allows for better versioning as documentation can live alongside the source (instead of uploading a new word doc for every change).

Proposed method Applicable documentation should be contained within the OpenAPI documentation and anything more verbose should be migrated to the OpenDCS ReadTheDocs.

MikeNeilson commented 9 months ago

oh FYI, I used pandoc to do the conversion to rst for the main OpenDCS documentation. I don't remember having major issues - though there was a lot of manual work dealing with the tables. Shouldn't be as bad as the main docs though.