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.

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

[02/01/2023] - Add Sphinxjs documentation to backend API code #149

Open
wants to merge 3 commits into
base: backend_dev
Choose a base branch
from

Conversation

RealRichi3
Copy link
Member

Summary

Attempted to implement sphinxjs for code documentation for the backend API.

Initial attempt was made here #147

List of changes proposed in this PR (pull-request)

  • Add required modules
  • Add code documentation
  • Attempted build with sphinx

What should a reviewer concentrate their feedback on?

  • Everything looks ok?

I attempted build, it successfully created the HTML file, but I can't see any documentation there

image

@the-label-bot the-label-bot bot added the kind/documentation kind/documentation label Jan 2, 2023
@the-label-bot
Copy link

the-label-bot bot commented Jan 2, 2023

The Label Bot has predicted the following:

Category Value Confidence Applied Label
Kind documentation 0.865 ✔️
Size XXL 0.716 ✔️

@BatoolMM BatoolMM added the wontfix This will not be worked on label Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend-dev kind/documentation kind/documentation wontfix This will not be worked on
Projects
Status: 🏗 In progress
Development

Successfully merging this pull request may close these issues.

2 participants