Skip to content

Commit 10e0d27

Browse files
committed
fix: Remove extra headings
1 parent cfa2be3 commit 10e0d27

File tree

2 files changed

+28
-22
lines changed

2 files changed

+28
-22
lines changed

bundle/internal/docs/docs.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ func buildMarkdown(nodes []rootNode, outputFile string) error {
9595
} else {
9696
m = m.H3(node.Title)
9797
}
98+
m = m.LF()
9899
m = m.PlainText(node.Description)
99100
m = m.LF()
100101

@@ -110,7 +111,7 @@ func buildMarkdown(nodes []rootNode, outputFile string) error {
110111
m = m.LF()
111112
m = buildAttributeTable(m, node.ArrayItemAttributes)
112113
} else if len(node.Attributes) > 0 {
113-
m = m.H4("Attributes")
114+
// m = m.H4("Attributes")
114115
m = m.LF()
115116
m = buildAttributeTable(m, node.Attributes)
116117
}

bundle/internal/docs/docs.md

Lines changed: 26 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11

22
## artifacts
3+
34
Defines the attributes to build an artifact
45

56

@@ -46,9 +47,9 @@ Each item has the following attributes:
4647

4748

4849
## bundle
50+
4951
The attributes of the bundle. See [_](/dev-tools/bundles/settings.md#bundle)
5052

51-
#### Attributes
5253

5354

5455
.. list-table::
@@ -88,9 +89,9 @@ The attributes of the bundle. See [_](/dev-tools/bundles/settings.md#bundle)
8889

8990

9091
### bundle.deployment
92+
9193
The definition of the bundle deployment
9294

93-
#### Attributes
9495

9596

9697
.. list-table::
@@ -110,9 +111,9 @@ The definition of the bundle deployment
110111

111112

112113
### bundle.deployment.lock
114+
113115
The deployment lock attributes.
114116

115-
#### Attributes
116117

117118

118119
.. list-table::
@@ -132,9 +133,9 @@ The deployment lock attributes.
132133

133134

134135
### bundle.git
136+
135137
The Git version control details that are associated with your bundle.
136138

137-
#### Attributes
138139

139140

140141
.. list-table::
@@ -154,9 +155,9 @@ The Git version control details that are associated with your bundle.
154155

155156

156157
## experimental
158+
157159
Defines attributes for experimental features.
158160

159-
#### Attributes
160161

161162

162163
.. list-table::
@@ -184,9 +185,9 @@ Defines attributes for experimental features.
184185

185186

186187
### experimental.pydabs
188+
187189
The PyDABs configuration.
188190

189-
#### Attributes
190191

191192

192193
.. list-table::
@@ -210,10 +211,12 @@ The PyDABs configuration.
210211

211212

212213
## include
214+
213215
Specifies a list of path globs that contain configuration files to include within the bundle. See [_](/dev-tools/bundles/settings.md#include)
214216

215217

216218
## permissions
219+
217220
Defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle. See [_](/dev-tools/bundles/settings.md#permissions) and [_](/dev-tools/bundles/permissions.md).
218221

219222
Each item of `permissions` has the following attributes:
@@ -244,9 +247,9 @@ Each item of `permissions` has the following attributes:
244247

245248

246249
## presets
250+
247251
Defines bundle deployment presets. See [_](/dev-tools/bundles/deployment-modes.md#presets).
248252

249-
#### Attributes
250253

251254

252255
.. list-table::
@@ -282,9 +285,9 @@ Defines bundle deployment presets. See [_](/dev-tools/bundles/deployment-modes.m
282285

283286

284287
## resources
288+
285289
Specifies information about the Databricks resources used by the bundle. See [_](/dev-tools/bundles/resources.md).
286290

287-
#### Attributes
288291

289292

290293
.. list-table::
@@ -340,9 +343,9 @@ Specifies information about the Databricks resources used by the bundle. See [_]
340343

341344

342345
## run_as
346+
343347
The identity to use to run the bundle.
344348

345-
#### Attributes
346349

347350

348351
.. list-table::
@@ -362,9 +365,9 @@ The identity to use to run the bundle.
362365

363366

364367
## sync
368+
365369
The files and file paths to include or exclude in the bundle. See [_](/dev-tools/bundles/)
366370

367-
#### Attributes
368371

369372

370373
.. list-table::
@@ -388,6 +391,7 @@ The files and file paths to include or exclude in the bundle. See [_](/dev-tools
388391

389392

390393
## targets
394+
391395
Defines deployment targets for the bundle.
392396

393397

@@ -470,9 +474,9 @@ Each item has the following attributes:
470474

471475

472476
### targets.bundle
477+
473478
The name of the bundle when deploying to this target.
474479

475-
#### Attributes
476480

477481

478482
.. list-table::
@@ -512,9 +516,9 @@ The name of the bundle when deploying to this target.
512516

513517

514518
### targets.bundle.deployment
519+
515520
The definition of the bundle deployment
516521

517-
#### Attributes
518522

519523

520524
.. list-table::
@@ -534,9 +538,9 @@ The definition of the bundle deployment
534538

535539

536540
### targets.bundle.deployment.lock
541+
537542
The deployment lock attributes.
538543

539-
#### Attributes
540544

541545

542546
.. list-table::
@@ -556,9 +560,9 @@ The deployment lock attributes.
556560

557561

558562
### targets.bundle.git
563+
559564
The Git version control details that are associated with your bundle.
560565

561-
#### Attributes
562566

563567

564568
.. list-table::
@@ -578,9 +582,9 @@ The Git version control details that are associated with your bundle.
578582

579583

580584
### targets.git
585+
581586
The Git version control settings for the target.
582587

583-
#### Attributes
584588

585589

586590
.. list-table::
@@ -600,9 +604,9 @@ The Git version control settings for the target.
600604

601605

602606
### targets.presets
607+
603608
The deployment presets for the target.
604609

605-
#### Attributes
606610

607611

608612
.. list-table::
@@ -638,9 +642,9 @@ The deployment presets for the target.
638642

639643

640644
### targets.resources
645+
641646
The resource definitions for the target.
642647

643-
#### Attributes
644648

645649

646650
.. list-table::
@@ -696,9 +700,9 @@ The resource definitions for the target.
696700

697701

698702
### targets.sync
703+
699704
The local paths to sync to the target workspace when a bundle is run or deployed.
700705

701-
#### Attributes
702706

703707

704708
.. list-table::
@@ -722,9 +726,9 @@ The local paths to sync to the target workspace when a bundle is run or deployed
722726

723727

724728
### targets.workspace
729+
725730
The Databricks workspace for the target.
726731

727-
#### Attributes
728732

729733

730734
.. list-table::
@@ -800,6 +804,7 @@ The Databricks workspace for the target.
800804

801805

802806
## variables
807+
803808
A Map that defines the custom variables for the bundle, where each key is the name of the variable, and the value is a Map that defines the variable.
804809

805810

@@ -842,9 +847,9 @@ Each item has the following attributes:
842847

843848

844849
### variables.lookup
850+
845851
The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.
846852

847-
#### Attributes
848853

849854

850855
.. list-table::
@@ -904,9 +909,9 @@ The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, m
904909

905910

906911
## workspace
912+
907913
Defines the Databricks workspace for the bundle.
908914

909-
#### Attributes
910915

911916

912917
.. list-table::

0 commit comments

Comments
 (0)