Please describe the feature you have in mind and explain what the current shortcomings are?
The API reference documentation from ayon-python-api is built as standalone Github pages.
To provide a consistent/centralized documentation we would need to embed it within the common Docusaurus website.
How would you imagine the implementation of the feature?
It looks like Docusaurus does not natively provide HTML/Sphinx extension.
BoTorch managed to merge their sphinx with their Docusaurus tho through custom python scripts that remove the sphinx stylesheet/js and replace it with a custom one.
Not entirely sure yet if this will allow for a dynamic conversion on the flight, or each change in ayon-python-apiwill have to trigger a website rebuild.
Are there any labels you wish to add?
[X] I have added the relevant labels to the enhancement request.
Describe alternatives you've considered:
No response
Additional context:
Rought estimate = 2-5 days of work but could easily turn into a tunnel work.
Is there an existing issue for this?
Please describe the feature you have in mind and explain what the current shortcomings are?
The API reference documentation from
ayon-python-apiis built as standalone Github pages. To provide a consistent/centralized documentation we would need to embed it within the common Docusaurus website.How would you imagine the implementation of the feature?
It looks like Docusaurus does not natively provide HTML/Sphinx extension.
BoTorch managed to merge their sphinx with their Docusaurus tho through custom python scripts that remove the sphinx stylesheet/js and replace it with a custom one.
More details here: https://github.com/facebook/docusaurus/issues/3894
To implement this properly I think we could recreate this logic from a custom Docusaurus React plugin. https://www.aknapen.nl/blog/how-to-build-a-plugin-for-docusaurus-v2/
Not entirely sure yet if this will allow for a dynamic conversion on the flight, or each change in
ayon-python-apiwill have to trigger a website rebuild.Are there any labels you wish to add?
Describe alternatives you've considered:
No response
Additional context:
Rought estimate = 2-5 days of work but could easily turn into a tunnel work.