Use Doxygen tagfile for apiref shortcode

[pzich]

Description:

The current apiref shortcode is based on string manipulation, essentially:

• get value after / (file name without path)
• replace all _ with __
• replace all . with _8
• replace all : with _1
• replace all capital letters with _<lowercase>

This works for most filenames, but if some files have the same name in different directories, that is included as well (see thread).

Since there isn't a way to generate these URLs consistently, this function uses the tagfile generated by GENERATE_TAGFILE (esphome/esphome#10794), converts that into an easily consumable map of file/struct/etc. name -> Doxygen URL

This also includes mappings for the above values excluding esphome::, esphome/, esphome/core/ and esphome/components/ so the shorter names can be used (e.g. sensor::Sensor instead of esphome::sensor::Sensor, or select/select.h instead of components/select/select.h or esphome/components/select/select.h).

Related issue (if applicable): fixes #5215

Pull request in esphome with YAML changes (if applicable):

• Add Doxygen GENERATE_TAGFILE to create lookup for classes and files esphome#10794

Checklist:

• I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
  or

• I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

• Link added in /components/index.rst when creating new documents for new components or cookbook.

[esphome]

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

[esphome]

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

[pzich]

Note: This won't work until esphome/esphome#10794 lands and is deployed everywhere, so for now I have been applying that locally, running doxygen, and changing this to something like:

Suggested change

	curl -s -S https://api-docs.esphome.io/tags.xml | script/format_api_tags.py > data/apirefs/current.json
	curl -s -S https://api-docs-beta.esphome.io/tags.xml | script/format_api_tags.py > data/apirefs/beta.json
	curl -s -S https://api-docs-dev.esphome.io/tags.xml | script/format_api_tags.py > data/apirefs/next.json
	cat /path/to/esphome/esphome/api-docs/tags.xml | script/format_api_tags.py > data/apirefs/current.json
	cp data/apirefs/current.json data/apirefs/beta.json
	cp data/apirefs/current.json data/apirefs/next.json

[esphome]

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

Base branch has been corrected - dismissing previous review.

[esphome]

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

[esphome]

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

Base branch has been corrected - dismissing previous review.

[pzich]

It seems like any mention of esphome/esphome PRs makes the bot insist this should only go into next, but it should probably go into current too depending on the timing.

Stale