hydra-python-agent icon indicating copy to clipboard operation
hydra-python-agent copied to clipboard
verified publisher icon HTTP-APIs

Added sphinx documentation

Open raoashish10 opened this issue 4 years ago • 3 comments

Checklist

  • [x] My branch is up-to-date with upstream/develop branch.
  • [x] Everything works and tested for Python 3.5.2 and above.

Description

Added a sphinx documentation for the hydra-python-agent repo as I noticed that it didn't have one. Also the documentation can then be hosted on readthedocs so that it can be embedded into the new documentation. The sphinx documentation was created specially for the automodule feature

Change logs

Added

A docs folder which contains the sphinx documentation.

I am running into some errors while using the agent with the new Movie API doc. So the index page is incomplete because it has certain examples missing which I will add as soon as I fix the erros.

raoashish10 avatar Feb 06 '21 05:02 raoashish10

Can you let me know what are errors that you are facing while using the agent so that we can fix them?

priyanshunayan avatar Feb 08 '21 04:02 priyanshunayan

@priyanshunayan Sure! I will add the steps. My doubt was that when I am trying to run the put function with the new Apidoc, I am getting an error: image

Am I missing any steps or am I making any mistake?

raoashish10 avatar Feb 08 '21 07:02 raoashish10

@priyanshunayan I managed to fix the error (@farazkhanfk7 helped out) and I have added examples for different types of request with the Movie api doc. Let me know if anything else needs to be changed. I have also added the steps to build the docs locally in a README file.

raoashish10 avatar Feb 15 '21 07:02 raoashish10