pg_readme_test_extension

Test generating a README.md document for extension or schema
Repository
bigsmoke/pg_readme
https://github.com/bigsmoke/pg_readme
Source
pg_readme-0.7.0.tar.gz
pg_readme-0.7.0.tar.gz

Overview

PackageVersionCategoryLicenseLanguage
pg_readme0.7.0UTILPostgreSQLC
IDExtensionBinLibLoadCreateTrustRelocSchema
4300pg_readmeNoNoNoYesYesYes-
4301pg_readme_test_extensionNoNoNoYesYesYes-
Relatedhstore schedoc gzip bzip zstd http pg_net pg_curl pgjq

Version

TypeRepoVersionPG VerPackageDeps
EXTMIXED0.7.01817161514pg_readmehstore
RPMPGDG0.7.01817161514pg_readme_$v-
DEBPIGSTY0.7.01817161514postgresql-$v-pg-readme-
OS / PGPG18PG17PG16PG15PG14
el8.x86_64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el8.aarch64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el9.x86_64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el9.aarch64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el10.x86_64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el10.aarch64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
d12.x86_64PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0
d12.aarch64PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0
d13.x86_64PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0
d13.aarch64PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0
u22.x86_64PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0
u22.aarch64PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0
u24.x86_64PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0
u24.aarch64PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0PIGSTY 0.7.0

Build

You can build the DEB packages for pg_readme using pig build:

pig build pkg pg_readme         # build DEB packages

Install

You can install pg_readme directly. First, make sure the PGDG and PIGSTY repositories are added and enabled:

pig repo add pgsql -u          # Add repo and update cache

Install the extension using pig or apt/yum/dnf:

pig install pg_readme;          # Install for current active PG version

pig ext install -y pg_readme -v 18  # PG 18
pig ext install -y pg_readme -v 17  # PG 17
pig ext install -y pg_readme -v 16  # PG 16
pig ext install -y pg_readme -v 15  # PG 15
pig ext install -y pg_readme -v 14  # PG 14

dnf install -y pg_readme_18       # PG 18
dnf install -y pg_readme_17       # PG 17
dnf install -y pg_readme_16       # PG 16
dnf install -y pg_readme_15       # PG 15
dnf install -y pg_readme_14       # PG 14

apt install -y postgresql-18-pg-readme   # PG 18
apt install -y postgresql-17-pg-readme   # PG 17
apt install -y postgresql-16-pg-readme   # PG 16
apt install -y postgresql-15-pg-readme   # PG 15
apt install -y postgresql-14-pg-readme   # PG 14

Create Extension:

CREATE EXTENSION pg_readme_test_extension CASCADE;  -- requires: hstore

Usage

pg_readme_test_extension: Test extension for pg_readme

This is a companion test extension for the pg_readme extension. It exists solely to test pg_readme’s functionality in generating documentation from PostgreSQL COMMENT objects.

It is not intended for direct use in production. It serves as a reference implementation demonstrating how to structure extension comments and processing instructions for pg_readme to generate proper README documentation.

See the pg_readme extension for the actual documentation generation functionality.


Last Modified 2026-03-12: add pg extension catalog (95749bf)