Feature/redoc documentation

[Edwardcg17]

Pull Request

Description

• Implemented a get endpoint for "/docs" so that it loads a custom Redocs style, similar to https://github.com/openclimatefix/uk-pv-national-gsp-api/blob/main/nowcasting_api/redoc_theme.py.
• Implemented a get endpoint to load the Quartz Solar Logo
• Added the logo png
• Implemented custom_openapi to load a custom schema
• Added the license file, copied from the UK repository

Fixes #112

How Has This Been Tested?

Starting the FastAPI server, then going to http://localhost:8000/docs. The page will be working documentation in Redoc style.

• [✔] Yes

If your changes affect data processing, have you plotted any changes? i.e. have you done a quick sanity check?

• N/A

Checklist:

• [✔] My code follows OCF's coding style guidelines
• [✔] I have performed a self-review of my own code
• [✔] I have made corresponding changes to the documentation
• [✔] I have added tests that prove my fix is effective or that my feature works
• [✔] I have checked my code and corrected any misspellings

[peterdudfield]

you ok to change it to https://app.quartz.energy/QUARTZENERGY_LOGO_TEXTONLY_WHITE.svg

[Edwardcg17]

Here is the current screenshot. I changed to the logo to the one you requested, but it's all white so it's barely visible:

This is a screenshot with the old logo:

/swagger does not bring up swagger docs. Do you still want it to?
Also, for future reference, should I comment on the issue or message you once I've submitted a pull request?

[peterdudfield]

yes, please, /swagger is useful too

perhaps, could you trim the "quartz solar" to just "quartz"

[peterdudfield]

One small change needed on the logo

Also, could you add a screen shot of /docs

Also, does /swagger still bring up swagger docs?

[Edwardcg17]

Shortened the logo and created the "/swagger" endpoint for swagger documentation. Screenshots:

Swagger:

Redoc:

[peterdudfield]

Thanks for this, ill merge on to a development branch just to check its working. If thats ok? ready to merge?

[Edwardcg17]

Yep, it should be ready to merge.

[peterdudfield]

Thnka you @Edwardcg17 for this

[peterdudfield]

Thanks @Edwardcg17 ,

@all-contributors please add @Edwardcg17 for code

[allcontributors]

@peterdudfield

I've put up a pull request to add @Edwardcg17! 🎉