DataBiosphere / data-store

AWS and GCP data storage system for genomic data.
https://dss.dev.ucsc-cgp-redwood.org
Other
3 stars 2 forks source link

Remove headers from swagger descriptions #98

Closed chmreid closed 4 years ago

chmreid commented 4 years ago

This PR must be merged before the data store CLI sphinx documentation can be built, which is required before we can fix the readthedocs documentation for the data store CLI.

Currently sphinx is raising errors due to markdown headers in the swagger description fields. The CLI tool grabs the swagger file, turns endpoints into CLI client methods/attributes, and converts the descriptions into docstrings.

Sphinx is failing on the step that turns docstrings (with headers) into Sphinx documentation. I have no idea how this was working for the HCA data store and CLI tool. This PR just removes the headers and makes the text bold formatted instead.

This PR closes databiosphere/data-store-cli#50

This is part of databiosphere/data-store-cli#49