This was a recommendation by the SEO team because the search engines expect URLs to comply with the above format. With Addons, we can get this format right before the docs go live to avoid having to set up redirects in the future.
This mechanism should only be enabled for the new Addon projects. It should be enabled in Pkg.ts.
Ensure objects.inv is updated correctly. Warning that we ignore objects.inv for the Addons for now because there is so much noise from the non-API docs being included in them.
Before: /api/qiskit-addon-obp/qiskit_addon_obp.utils.MyClass After: /api/qiskit-addon-obp/utils-my-class
This was a recommendation by the SEO team because the search engines expect URLs to comply with the above format. With Addons, we can get this format right before the docs go live to avoid having to set up redirects in the future.
This mechanism should only be enabled for the new Addon projects. It should be enabled in
Pkg.ts.Ensure objects.inv is updated correctly. Warning that we ignore objects.inv for the Addons for now because there is so much noise from the non-API docs being included in them.