Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc(#203): add openapi and swagger page to RTD #204

Merged
merged 1 commit into from
May 15, 2021
Merged

doc(#203): add openapi and swagger page to RTD #204

merged 1 commit into from
May 15, 2021

Conversation

Radi85
Copy link
Owner

@Radi85 Radi85 commented May 14, 2021 •
edited
Loading

closes #203

@Radi85 Radi85 requested a review from abhiabhi94 May 14, 2021 08:38
@abhiabhi94
Copy link
Collaborator

abhiabhi94 commented May 15, 2021 •
edited
Loading

I just saw that the batch for documentation build displays it as failing. I can build it successfully(from the develop branch) locally albeit with some warning. Do you have any further information?

@Radi85
Copy link
Owner Author

Radi85 commented May 15, 2021

I just saw that the batch for documentation build displays it as failing. I can build it successfully(from the develop branch) locally albeit with some warning. Do you have any further information?

I am not sure which patch you are refering to. This is the build result of this branch on RTD https://django-comment-dab.readthedocs.io/en/add-swagger-page/WebAPI.html and there is not issue with it.

@abhiabhi94
Copy link
Collaborator

abhiabhi94 commented May 15, 2021 •
edited
Loading

The one used in our README file: see the link

I'm not talking about this branch, but our develop branch.

@Radi85
Copy link
Owner Author

Radi85 commented May 15, 2021

The one used in our README file: see the link

I'm not talking about this branch, but our develop branch.

Ah I just saw it, I think bcz tried many times before getting the build work. I will investigate it.

@Radi85
Copy link
Owner Author

Radi85 commented May 15, 2021

The one used in our README file: see the link

I'm not talking about this branch, but our develop branch.

This is fixed, the reason behind it is the requirement file docs/source/requirements.txt. This file doesn't exist yet on develop and it's already in RTD settings.
There won't be any issue after merging this.

abhiabhi94
abhiabhi94 approved these changes May 15, 2021
View reviewed changes
Copy link
Collaborator

@abhiabhi94 abhiabhi94 left a comment

Choose a reason for hiding this comment

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

thanks for this.

@Radi85 Radi85 merged commit 110d3e7 into develop May 15, 2021
@Radi85 Radi85 deleted the add-swagger-page branch May 23, 2021 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abhiabhi94 abhiabhi94 abhiabhi94 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add swagger docs for the API
2 participants
@Radi85 @abhiabhi94