First congrats on baking this extension.
I tried to test this extension on Citus extension.
On my local environment, I built pg_readme from source and installed it. I have some other extensions installed as well.
SELECT e.extname AS "Name", e.extversion AS "Version", n.nspname AS "Schema"
FROM pg_catalog.pg_extension e
LEFT JOIN pg_catalog.pg_namespace n ON n.oid = e.extnamespace
LEFT JOIN pg_catalog.pg_description c ON c.objoid = e.oid AND c.classoid = 'pg_catalog.pg_extension'::pg_catalog.regclass
ORDER BY 1;
+----------------+---------+------------+
| Name | Version | Schema |
+----------------+---------+------------+
| citus | 11.2-1 | pg_catalog |
| citus_columnar | 11.2-1 | pg_catalog |
| hstore | 1.8 | public |
| pg_readme | 0.5.5 | public |
| plpgsql | 1.0 | pg_catalog |
+----------------+---------+------------+
(5 rows)
Citus has 100+ objects: tables, UDFs, GUCs, types etc. None of them are listed on the generated readme.
SELECT pg_extension_readme('citus');
+------------------------------------------------------+
| pg_extension_readme |
+------------------------------------------------------+
| --- +|
| pg_extension_name: citus +|
| pg_extension_version: 11.2-1 +|
| pg_readme_generated_at: 2023-01-25 16:29:23.03844+03+|
| pg_readme_version: 0.5.5 +|
| --- +|
| +|
| Citus distributed database |
+------------------------------------------------------+
(1 row)