Skip to content

Commit

Permalink
docs: fix genref config (cloudnative-pg#6422)
Browse files Browse the repository at this point in the history
Signed-off-by: Marco Nenciarini <[email protected]>
  • Loading branch information
mnencia authored Dec 22, 2024
1 parent 74507bb commit c765572
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 14 deletions.
18 changes: 10 additions & 8 deletions docs/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,16 @@ externalPackages:

hideTypePatterns:
- "ParseError$"
# We cannot exclude all `List$` because we declare PluginConfigurationList
- "BackupList$"
- "ClusterList$"
- "ClusterImageCatalogList$"
- "DatabaseList$"
- "ImageCatalogList$"
- "PoolerList$"
- "ScheduledBackupList$"
# We cannot exclude all `List$` because we declare PluginConfigurationList and ExternalClusterList
- "\\.BackupList$"
- "\\.ClusterList$"
- "\\.ClusterImageCatalogList$"
- "\\.DatabaseList$"
- "\\.ImageCatalogList$"
- "\\.PoolerList$"
- "\\.ScheduledBackupList$"
- "\\.PublicationList$"
- "\\.SubscriptionList$"

markdownDisabled: false

Expand Down
20 changes: 14 additions & 6 deletions docs/src/cloudnative-pg.v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,9 +229,6 @@ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-
## Publication {#postgresql-cnpg-io-v1-Publication}


**Appears in:**



<p>Publication is the Schema for the publications API</p>

Expand Down Expand Up @@ -303,9 +300,6 @@ More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-
## Subscription {#postgresql-cnpg-io-v1-Subscription}


**Appears in:**



<p>Subscription is the Schema for the subscriptions API</p>

Expand Down Expand Up @@ -2712,6 +2706,20 @@ storage</p>
</tbody>
</table>

## ExternalClusterList {#postgresql-cnpg-io-v1-ExternalClusterList}

(Alias of `[]github.com/cloudnative-pg/cloudnative-pg/api/v1.ExternalCluster`)

**Appears in:**

- [ClusterSpec](#postgresql-cnpg-io-v1-ClusterSpec)


<p>ExternalClusterList is a list of external clusters</p>




## ImageCatalogRef {#postgresql-cnpg-io-v1-ImageCatalogRef}


Expand Down

0 comments on commit c765572

Please sign in to comment.