Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

PB-558 Render the swagger files in the documentation #358

Merged
merged 6 commits into from
Apr 6, 2020

Conversation

Robert-Steiner
Copy link
Contributor

@Robert-Steiner Robert-Steiner commented Apr 2, 2020

Reference:

Summary

  • revived old readthedocs documention setup
  • added swagger files to the documentation
  • added a description how to use swagger ui in order to view the swagger files

@Robert-Steiner Robert-Steiner marked this pull request as ready for review April 2, 2020 17:47
README.md Show resolved Hide resolved
Copy link
Contributor

@little-dude little-dude left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a couple question. I'd like to build the docs and see how it looks before approving. I also think we could strip down the README quite a lot: all of the implementation details belong to the Rust doc imo. I'll suggest some changes in that area.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
little-dude and others added 3 commits April 6, 2020 14:23
- use a separate README for the repo and for readthedocs
- remove the implementation details from the repo's main README. That
  part of the documentation belong to the Rust documentation and was
  slightly outdated anyway
- remove the keras example README, which was outdated and redundant
  with the instructions in the repo's README
@little-dude little-dude self-requested a review April 6, 2020 13:07
Copy link
Contributor

@little-dude little-dude left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@Robert-Steiner Robert-Steiner merged commit e7069e1 into master Apr 6, 2020
@Robert-Steiner Robert-Steiner deleted the PB-558-provide-swagger-as-markdown branch April 6, 2020 13:13
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants