Publish the current api docs to docs.openedx.org

[feanil]

The API docs currently generate swagger schema and sphinx docs locally. Figure out how to publish them to some path under https://docs.openedx.org so that they are easy for everyone to view.

Note: The docs will still need a lot of work after that but at-least get them published so people can start looking at them.

[feanil]

PRs in support of this work:

• feanil/platform docs #32611
• docs: Add feature toggle and settings to the guide. #32612
• feanil/reorg guides #32614

[mehedikhan72]

Hi @feanil , would love to take on this issue and see what I can do to provide some help.

However, I've been getting so much errors in the console trying to build the requirements in the base.txt. Running 'make html' inside 'edx-platform/docs/guides' causes some other exceptions and ImportErrors and so on. I'm using tutor. Being new here, where can I get help when I'm stuck or facing something I can't figure out myself?

Update: I got the docs to run locally, with a lot of warnings in the console. Still would very much appreciate a place where I can ask for help and directions regarding this issue.

[feanil]

@mehedikhan72 the discussion forums are a good place to ask for help. I'd love some help getting rid of the various warnings that occur as a part of the build. Maybe you can post your specific issues there and we can work through them. FYI, I'll be on vacation for the rest of the week so I may be slow to respond until next week.

[mehedikhan72]

@feanil Sure, I'll build the docs again and post the warnings in the discussion forums as well as trying to move forward with publishing the current api docs to docs.openedx.org.

[feanil]

@mehedikhan72 I can take care of publishing, I don't think you'll have the relevant access to do that yet, but if you can focus on PRs that reduce the number of warnings, I'm happy to get those reviewed and landed.

[feanil]

The REST API docs are now being published here: https://docs.openedx.org/projects/edx-platform/en/latest/references/lms_apis.html