feat: Added api_docs and sitemap and removed version dropdown - #611
feat: Added api_docs and sitemap and removed version dropdown#611BrigittaK307 wants to merge 14 commits into
Conversation
There was a problem hiding this comment.
[req] I think this doesn't belong here.
There was a problem hiding this comment.
[req] Also, all of the python and other project files from the original repo don't belong here.
There was a problem hiding this comment.
[req] This looks like a generated file, that also doesn't belong here (applies to everything under _sources.
There was a problem hiding this comment.
For now the python sidebar point to these files, because this was the easiest way for now to adapt to the current repo setup. So Docusaurus doesn't process these files, these are the Sphinx-generated HTML files.
There was a problem hiding this comment.
[req] I believe everything under docs-python/gen doesn't belong here.
| filename: 'sitemap-python.xml', | ||
| changefreq: 'weekly', | ||
| priority: 0.5, | ||
| ignorePatterns: ['**/docs/java/**', '**/docs/js/**'] |
There was a problem hiding this comment.
[req] Please, also adjust the sitemaps of java and js to ignore python.
| { | ||
| type: 'link', | ||
| label: 'API Reference', | ||
| href: 'pathname:///api-python/_api_doc/gen_ai_hub.html' |
There was a problem hiding this comment.
[req] I can see that under api-python there is an index.html. I think we should use that.
marikaner
left a comment
marikaner
left a comment
There was a problem hiding this comment.
I think the visual issues are fixed, right?
There was a problem hiding this comment.
[q] Is this not referenced in the samples?
There was a problem hiding this comment.
This was deleted, because it was only used in the Jupyter notebooks and we render only the .mdx files, not the notebooks.
There was a problem hiding this comment.
[pp] base and core are in separate directories, I would prefer it if this was also the case for gen.
There was a problem hiding this comment.
[q] This looks AI generated? Why do we need it?
There was a problem hiding this comment.
Forgot to delete it. This was the way I wanted to handle the Visual issues before Sphinx generation was configured for all the packages. Will delete it.
Yes, because in the code repo I have configured the Sphinx api docs generation for the base and core packages as well (before it was only for gen). I will push those changes today. |
…ot needed anymore
2 participants
What Has Changed?
Explain what you are changing and why, if it isn't obvious from the diff.