Generating Extension API documentation

83 views
Skip to first unread message

Ravi Kasibhatla

unread,
Jun 23, 2023, 9:28:28 AM6/23/23
to Chromium-dev, blink-dev
Hi,

How to generate documentation from extension API json schema?

Searching chromium docs, it points about getting generated from .json schema files [1]

Documentation
The public documentation hosted at https://developer.chrome.com/extensions is largely generated from the API specifications. Everything from the function descriptions to parameter ordering to exposed types and enums is generated from the specification. Because this becomes our public documentation, special care should be given to ensure that descriptions for events, functions, properties, and arguments are clear and well-formed.

The chromium documentation also points to adding templates to generate extension API documentation [2]

Add and Verify Documentation
Much of the documentation for extension APIs is auto-generated from the schema files. This includes method signatures and descriptions and type descriptions. If you don't require any additional documentation, the only required step is to add a new template article in chrome/common/extensions/docs/templates/public/extensions. If you need additional documentation, you can also add an article in chrome/common/extensions/docs/templates/intros.
To verify the documentation is correctly included and visible, run the preview mode of the documentation server by running chrome/common/extensions/docs/server2/preview.py and visiting localhost:8000/extensions/<apiName>

However, I don't find either of the mentioned folders (docs/templates) or files (server2/preview.py) to generate the documentation.

Are the files and scripts removed from the latest code base? If yes, how to generate it now?
If not, where is it moved to?

Regards,
Ravi Kasibhatla.


PhistucK

unread,
Jun 24, 2023, 5:57:58 PM6/24/23
to kasibha...@gmail.com, Chromium-dev, blink-dev

--
--
Chromium Developers mailing list: chromi...@chromium.org
View archives, change email options, or unsubscribe:
http://groups.google.com/a/chromium.org/group/chromium-dev
---
You received this message because you are subscribed to the Google Groups "Chromium-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to chromium-dev...@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/chromium-dev/CAJAFTJiZgDnpSU5f5FN63FDrFEZph8dF2dyzmLWd6zFYjeu%2B%3Dg%40mail.gmail.com.
Reply all
Reply to author
Forward
0 new messages