Added sphinx documentation #163
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can you let me know what are errors that you are facing while using the agent so that we can fix them? |
|
@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: Am I missing any steps or am I making any mistake? |
|
@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. |
priyanshunayan
previously requested changes
Feb 15, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
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.