aws-cli/awscli/clidocs.py at develop · ProGamerCode/aws-cli · GitHub

History

698 lines (614 loc) · 27.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

# Licensed under the Apache License, Version 2.0 (the "License"). You

# may not use this file except in compliance with the License. A copy of

# the License is located at

# http://aws.amazon.com/apache2.0/

# or in the "license" file accompanying this file. This file is

# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF

# ANY KIND, either express or implied. See the License for the specific

# language governing permissions and limitations under the License.

import logging

import os

from botocore import xform_name

from botocore.docs.bcdoc.docevents import DOC_EVENTS

from botocore.model import StringShape

from botocore.utils import is_json_value_header

from awscli import SCALAR_TYPES

from awscli.argprocess import ParamShorthandDocGen

from awscli.topictags import TopicTagDB

from awscli.utils import find_service_and_method_in_event_name

LOG = logging.getLogger(__name__)

class CLIDocumentEventHandler(object):

def __init__(self, help_command):

self.help_command = help_command

self.register(help_command.session, help_command.event_class)

self.help_command.doc.translation_map = self.build_translation_map()

self._arg_groups = self._build_arg_table_groups(help_command)

self._documented_arg_groups = []

def _build_arg_table_groups(self, help_command):

arg_groups = {}

for name, arg in help_command.arg_table.items():

if arg.group_name is not None:

arg_groups.setdefault(arg.group_name, []).append(arg)

return arg_groups

def build_translation_map(self):

return dict()

def _get_argument_type_name(self, shape, default):

if is_json_value_header(shape):

return 'JSON'

return default

def _map_handlers(self, session, event_class, mapfn):

for event in DOC_EVENTS:

event_handler_name = event.replace('-', '_')

if hasattr(self, event_handler_name):

event_handler = getattr(self, event_handler_name)

format_string = DOC_EVENTS[event]

num_args = len(format_string.split('.')) - 2

format_args = (event_class,) + ('*',) * num_args

event_string = event + format_string % format_args

unique_id = event_class + event_handler_name

mapfn(event_string, event_handler, unique_id)

def register(self, session, event_class):

"""

The default register iterates through all of the

available document events and looks for a corresponding

handler method defined in the object. If it's there, that

handler method will be registered for the all events of

that type for the specified ``event_class``.

"""

self._map_handlers(session, event_class, session.register)

def unregister(self):

"""

The default unregister iterates through all of the

available document events and looks for a corresponding

handler method defined in the object. If it's there, that

handler method will be unregistered for the all events of

that type for the specified ``event_class``.

"""

self._map_handlers(self.help_command.session,

self.help_command.event_class,

self.help_command.session.unregister)

# These are default doc handlers that apply in the general case.

def doc_breadcrumbs(self, help_command, **kwargs):

doc = help_command.doc

if doc.target != 'man':

cmd_names = help_command.event_class.split('.')

doc.write('[ ')

doc.write(':ref:`aws <cli:aws>`')

full_cmd_list = ['aws']

for cmd in cmd_names[:-1]:

doc.write(' . ')

full_cmd_list.append(cmd)

full_cmd_name = ' '.join(full_cmd_list)

doc.write(':ref:`%s <cli:%s>`' % (cmd, full_cmd_name))

doc.write(' ]')

def doc_title(self, help_command, **kwargs):

doc = help_command.doc

doc.style.new_paragraph()

reference = help_command.event_class.replace('.', ' ')

if reference != 'aws':

reference = 'aws ' + reference

doc.writeln('.. _cli:%s:' % reference)

doc.style.h1(help_command.name)

def doc_description(self, help_command, **kwargs):

doc = help_command.doc

doc.style.h2('Description')

doc.include_doc_string(help_command.description)

doc.style.new_paragraph()

def doc_synopsis_start(self, help_command, **kwargs):

self._documented_arg_groups = []

doc = help_command.doc

doc.style.h2('Synopsis')

doc.style.start_codeblock()

doc.writeln('%s' % help_command.name)

def doc_synopsis_option(self, arg_name, help_command, **kwargs):

doc = help_command.doc

argument = help_command.arg_table[arg_name]

if argument.group_name in self._arg_groups:

if argument.group_name in self._documented_arg_groups:

# This arg is already documented so we can move on.

return

option_str = ' | '.join(

[a.cli_name for a in

self._arg_groups[argument.group_name]])

self._documented_arg_groups.append(argument.group_name)

else:

option_str = '%s <value>' % argument.cli_name

if not (argument.required

or getattr(argument, '_DOCUMENT_AS_REQUIRED', False)):

option_str = '[%s]' % option_str

doc.writeln('%s' % option_str)

def doc_synopsis_end(self, help_command, **kwargs):

doc = help_command.doc

doc.style.end_codeblock()

# Reset the documented arg groups for other sections

# that may document args (the detailed docs following

# the synopsis).

self._documented_arg_groups = []

def doc_options_start(self, help_command, **kwargs):

doc = help_command.doc

doc.style.h2('Options')

if not help_command.arg_table:

doc.write('*None*\n')

def doc_option(self, arg_name, help_command, **kwargs):

doc = help_command.doc

argument = help_command.arg_table[arg_name]

if argument.group_name in self._arg_groups:

if argument.group_name in self._documented_arg_groups:

# This arg is already documented so we can move on.

return

name = ' | '.join(

['``%s``' % a.cli_name for a in

self._arg_groups[argument.group_name]])

self._documented_arg_groups.append(argument.group_name)

else:

name = '``%s``' % argument.cli_name

doc.write('%s (%s)\n' % (name, self._get_argument_type_name(

argument.argument_model, argument.cli_type_name)))

doc.style.indent()

doc.include_doc_string(argument.documentation)

self._document_enums(argument, doc)

doc.style.dedent()

doc.style.new_paragraph()

def doc_relateditems_start(self, help_command, **kwargs):

if help_command.related_items:

doc = help_command.doc

doc.style.h2('See Also')

def doc_relateditem(self, help_command, related_item, **kwargs):

doc = help_command.doc

doc.write('* ')

doc.style.sphinx_reference_label(

label='cli:%s' % related_item,

text=related_item

)

doc.write('\n')

def _document_enums(self, argument, doc):

"""Documents top-level parameter enums"""

if hasattr(argument, 'argument_model'):

model = argument.argument_model

if isinstance(model, StringShape):

if model.enum:

doc.style.new_paragraph()

doc.write('Possible values:')

doc.style.start_ul()

for enum in model.enum:

doc.style.li('``%s``' % enum)

doc.style.end_ul()

class ProviderDocumentEventHandler(CLIDocumentEventHandler):

def doc_breadcrumbs(self, help_command, event_name, **kwargs):

pass

def doc_synopsis_start(self, help_command, **kwargs):

doc = help_command.doc

doc.style.h2('Synopsis')

doc.style.codeblock(help_command.synopsis)

doc.include_doc_string(help_command.help_usage)

def doc_synopsis_option(self, arg_name, help_command, **kwargs):

pass

def doc_synopsis_end(self, help_command, **kwargs):

doc = help_command.doc

doc.style.new_paragraph()

def doc_options_start(self, help_command, **kwargs):

doc = help_command.doc

doc.style.h2('Options')

def doc_option(self, arg_name, help_command, **kwargs):

doc = help_command.doc

argument = help_command.arg_table[arg_name]

doc.writeln('``%s`` (%s)' % (argument.cli_name,

argument.cli_type_name))

doc.include_doc_string(argument.documentation)

if argument.choices:

doc.style.start_ul()

for choice in argument.choices:

doc.style.li(choice)

doc.style.end_ul()

def doc_subitems_start(self, help_command, **kwargs):

doc = help_command.doc

doc.style.h2('Available Services')

doc.style.toctree()

def doc_subitem(self, command_name, help_command, **kwargs):

doc = help_command.doc

file_name = '%s/index' % command_name

doc.style.tocitem(command_name, file_name=file_name)

class ServiceDocumentEventHandler(CLIDocumentEventHandler):

def build_translation_map(self):

d = {}

service_model = self.help_command.obj

for operation_name in service_model.operation_names:

d[operation_name] = xform_name(operation_name, '-')

return d

# A service document has no synopsis.

def doc_synopsis_start(self, help_command, **kwargs):

pass

def doc_synopsis_option(self, arg_name, help_command, **kwargs):

pass

def doc_synopsis_end(self, help_command, **kwargs):

pass

# A service document has no option section.

def doc_options_start(self, help_command, **kwargs):

pass

def doc_option(self, arg_name, help_command, **kwargs):

pass

def doc_option_example(self, arg_name, help_command, **kwargs):

pass

def doc_options_end(self, help_command, **kwargs):

pass

def doc_description(self, help_command, **kwargs):

doc = help_command.doc

service_model = help_command.obj

doc.style.h2('Description')

# TODO: need a documentation attribute.

doc.include_doc_string(service_model.documentation)

def doc_subitems_start(self, help_command, **kwargs):

doc = help_command.doc

doc.style.h2('Available Commands')

doc.style.toctree()

def doc_subitem(self, command_name, help_command, **kwargs):

doc = help_command.doc

subcommand = help_command.command_table[command_name]

subcommand_table = getattr(subcommand, 'subcommand_table', {})

# If the subcommand table has commands in it,

# direct the subitem to the command's index because

# it has more subcommands to be documented.

if (len(subcommand_table) > 0):

file_name = '%s/index' % command_name

doc.style.tocitem(command_name, file_name=file_name)

else:

doc.style.tocitem(command_name)

class OperationDocumentEventHandler(CLIDocumentEventHandler):

AWS_DOC_BASE = 'https://docs.aws.amazon.com/goto/WebAPI'

def build_translation_map(self):

operation_model = self.help_command.obj

d = {}

for cli_name, cli_argument in self.help_command.arg_table.items():

if cli_argument.argument_model is not None:

argument_name = cli_argument.argument_model.name

if argument_name in d:

previous_mapping = d[argument_name]

# If the argument name is a boolean argument, we want the

# the translation to default to the one that does not start

# with --no-. So we check if the cli parameter currently

# being used starts with no- and if stripping off the no-

# results in the new proposed cli argument name. If it

# does, we assume we have the postive form of the argument

# which is the name we want to use in doc translations.

if cli_argument.cli_type_name == 'boolean' and \

previous_mapping.startswith('no-') and \

cli_name == previous_mapping[3:]:

d[argument_name] = cli_name

else:

d[argument_name] = cli_name

for operation_name in operation_model.service_model.operation_names:

d[operation_name] = xform_name(operation_name, '-')

return d

def doc_description(self, help_command, **kwargs):

doc = help_command.doc

operation_model = help_command.obj

doc.style.h2('Description')

doc.include_doc_string(operation_model.documentation)

self._add_webapi_crosslink(help_command)

def _add_webapi_crosslink(self, help_command):

doc = help_command.doc

operation_model = help_command.obj

service_model = operation_model.service_model

service_uid = service_model.metadata.get('uid')

if service_uid is None:

# If there's no service_uid in the model, we can't

# be certain if the generated cross link will work

# so we don't generate any crosslink info.

return

doc.style.new_paragraph()

doc.write("See also: ")

link = '%s/%s/%s' % (self.AWS_DOC_BASE, service_uid,

operation_model.name)

doc.style.external_link(title="AWS API Documentation", link=link)

doc.writeln('')

def _json_example_value_name(self, argument_model, include_enum_values=True):

# If include_enum_values is True, then the valid enum values

# are included as the sample JSON value.

if isinstance(argument_model, StringShape):

if argument_model.enum and include_enum_values:

choices = argument_model.enum

return '|'.join(['"%s"' % c for c in choices])

else:

return '"string"'

elif argument_model.type_name == 'boolean':

return 'true|false'

else:

return '%s' % argument_model.type_name

def _json_example(self, doc, argument_model, stack):

if argument_model.name in stack:

# Document the recursion once, otherwise just

# note the fact that it's recursive and return.

if stack.count(argument_model.name) > 1:

if argument_model.type_name == 'structure':

doc.write('{ ... recursive ... }')

return

stack.append(argument_model.name)

try:

self._do_json_example(doc, argument_model, stack)

finally:

stack.pop()

def _do_json_example(self, doc, argument_model, stack):

if argument_model.type_name == 'list':

doc.write('[')

if argument_model.member.type_name in SCALAR_TYPES:

doc.write('%s, ...' % self._json_example_value_name(argument_model.member))

else:

doc.style.indent()

doc.style.new_line()

self._json_example(doc, argument_model.member, stack)

doc.style.new_line()

doc.write('...')

doc.style.dedent()

doc.style.new_line()

doc.write(']')

elif argument_model.type_name == 'map':

doc.write('{')

doc.style.indent()

key_string = self._json_example_value_name(argument_model.key)

doc.write('%s: ' % key_string)

if argument_model.value.type_name in SCALAR_TYPES:

doc.write(self._json_example_value_name(argument_model.value))

else:

doc.style.indent()

self._json_example(doc, argument_model.value, stack)

doc.style.dedent()

doc.style.new_line()

doc.write('...')

doc.style.dedent()

doc.write('}')

elif argument_model.type_name == 'structure':

self._doc_input_structure_members(doc, argument_model, stack)

def _doc_input_structure_members(self, doc, argument_model, stack):

doc.write('{')

doc.style.indent()

doc.style.new_line()

members = argument_model.members

for i, member_name in enumerate(members):

member_model = members[member_name]

member_type_name = member_model.type_name

if member_type_name in SCALAR_TYPES:

doc.write('"%s": %s' % (member_name,

self._json_example_value_name(member_model)))

elif member_type_name == 'structure':

doc.write('"%s": ' % member_name)

self._json_example(doc, member_model, stack)

elif member_type_name == 'map':

doc.write('"%s": ' % member_name)

self._json_example(doc, member_model, stack)

elif member_type_name == 'list':

doc.write('"%s": ' % member_name)

self._json_example(doc, member_model, stack)

if i < len(members) - 1:

doc.write(',')

doc.style.new_line()

doc.style.dedent()

doc.style.new_line()

doc.write('}')

def doc_option_example(self, arg_name, help_command, event_name, **kwargs):

service_name, operation_name = \

find_service_and_method_in_event_name(event_name)

doc = help_command.doc

cli_argument = help_command.arg_table[arg_name]

if cli_argument.group_name in self._arg_groups:

if cli_argument.group_name in self._documented_arg_groups:

# Args with group_names (boolean args) don't

# need to generate example syntax.

return

argument_model = cli_argument.argument_model

docgen = ParamShorthandDocGen()

if docgen.supports_shorthand(cli_argument.argument_model):

example_shorthand_syntax = docgen.generate_shorthand_example(

cli_argument, service_name, operation_name)

if example_shorthand_syntax is None:

# If the shorthand syntax returns a value of None,

# this indicates to us that there is no example

# needed for this param so we can immediately

# return.

return

if example_shorthand_syntax:

doc.style.new_paragraph()

doc.write('Shorthand Syntax')

doc.style.start_codeblock()

for example_line in example_shorthand_syntax.splitlines():

doc.writeln(example_line)

doc.style.end_codeblock()

if argument_model is not None and argument_model.type_name == 'list' and \

argument_model.member.type_name in SCALAR_TYPES:

# A list of scalars is special. While you *can* use

# JSON ( ["foo", "bar", "baz"] ), you can also just

# use the argparse behavior of space separated lists.

# "foo" "bar" "baz". In fact we don't even want to

# document the JSON syntax in this case.

member = argument_model.member

doc.style.new_paragraph()

doc.write('Syntax')

doc.style.start_codeblock()

example_type = self._json_example_value_name(

member, include_enum_values=False)

doc.write('%s %s ...' % (example_type, example_type))

if isinstance(member, StringShape) and member.enum:

# If we have enum values, we can tell the user

# exactly what valid values they can provide.

self._write_valid_enums(doc, member.enum)

doc.style.end_codeblock()

doc.style.new_paragraph()

elif cli_argument.cli_type_name not in SCALAR_TYPES:

doc.style.new_paragraph()

doc.write('JSON Syntax')

doc.style.start_codeblock()

self._json_example(doc, argument_model, stack=[])

doc.style.end_codeblock()

doc.style.new_paragraph()

def _write_valid_enums(self, doc, enum_values):

doc.style.new_paragraph()

doc.write("Where valid values are:\n")

for value in enum_values:

doc.write(" %s\n" % value)

doc.write("\n")

def doc_output(self, help_command, event_name, **kwargs):

doc = help_command.doc

doc.style.h2('Output')

operation_model = help_command.obj

output_shape = operation_model.output_shape

if output_shape is None:

doc.write('None')

else:

for member_name, member_shape in output_shape.members.items():

self._doc_member_for_output(doc, member_name, member_shape, stack=[])

def _doc_member_for_output(self, doc, member_name, member_shape, stack):

if member_shape.name in stack:

# Document the recursion once, otherwise just

# note the fact that it's recursive and return.

if stack.count(member_shape.name) > 1:

if member_shape.type_name == 'structure':

doc.write('( ... recursive ... )')

return

stack.append(member_shape.name)

try:

self._do_doc_member_for_output(doc, member_name,

member_shape, stack)

finally:

stack.pop()

def _do_doc_member_for_output(self, doc, member_name, member_shape, stack):

docs = member_shape.documentation

if member_name:

doc.write('%s -> (%s)' % (member_name, self._get_argument_type_name(

member_shape, member_shape.type_name)))

else:

doc.write('(%s)' % member_shape.type_name)

doc.style.indent()

doc.style.new_paragraph()

doc.include_doc_string(docs)

doc.style.new_paragraph()

member_type_name = member_shape.type_name

if member_type_name == 'structure':

for sub_name, sub_shape in member_shape.members.items():

self._doc_member_for_output(doc, sub_name, sub_shape, stack)

elif member_type_name == 'map':

key_shape = member_shape.key

key_name = key_shape.serialization.get('name', 'key')

self._doc_member_for_output(doc, key_name, key_shape, stack)

value_shape = member_shape.value

value_name = value_shape.serialization.get('name', 'value')

self._doc_member_for_output(doc, value_name, value_shape, stack)

elif member_type_name == 'list':

self._doc_member_for_output(doc, '', member_shape.member, stack)

doc.style.dedent()

doc.style.new_paragraph()

class TopicListerDocumentEventHandler(CLIDocumentEventHandler):

DESCRIPTION = (

'This is the AWS CLI Topic Guide. It gives access to a set '

'of topics that provide a deeper understanding of the CLI. To access '

'the list of topics from the command line, run ``aws help topics``. '

'To access a specific topic from the command line, run '

'``aws help [topicname]``, where ``topicname`` is the name of the '

'topic as it appears in the output from ``aws help topics``.')

def __init__(self, help_command):

self.help_command = help_command

self.register(help_command.session, help_command.event_class)

self.help_command.doc.translation_map = self.build_translation_map()

self._topic_tag_db = TopicTagDB()

self._topic_tag_db.load_json_index()

def doc_breadcrumbs(self, help_command, **kwargs):

doc = help_command.doc

if doc.target != 'man':

doc.write('[ ')

doc.style.sphinx_reference_label(label='cli:aws', text='aws')

doc.write(' ]')

def doc_title(self, help_command, **kwargs):

doc = help_command.doc

doc.style.new_paragraph()

doc.style.link_target_definition(

refname='cli:aws help %s' % self.help_command.name,

link='')

doc.style.h1('AWS CLI Topic Guide')

def doc_description(self, help_command, **kwargs):

doc = help_command.doc

doc.style.h2('Description')

doc.include_doc_string(self.DESCRIPTION)

doc.style.new_paragraph()

def doc_synopsis_start(self, help_command, **kwargs):

pass

def doc_synopsis_end(self, help_command, **kwargs):

pass

def doc_options_start(self, help_command, **kwargs):

pass

def doc_options_end(self, help_command, **kwargs):

pass

def doc_subitems_start(self, help_command, **kwargs):

doc = help_command.doc

doc.style.h2('Available Topics')

categories = self._topic_tag_db.query('category')

topic_names = self._topic_tag_db.get_all_topic_names()

# Sort the categories

category_names = sorted(categories.keys())

for category_name in category_names:

doc.style.h3(category_name)

doc.style.new_paragraph()

# Write out the topic and a description for each topic under

# each category.

for topic_name in sorted(categories[category_name]):

description = self._topic_tag_db.get_tag_single_value(

topic_name, 'description')

doc.write('* ')

doc.style.sphinx_reference_label(

label='cli:aws help %s' % topic_name,

text=topic_name

)

doc.write(': %s\n' % description)

# Add a hidden toctree to make sure everything is connected in

# the document.

doc.style.hidden_toctree()

for topic_name in topic_names:

doc.style.hidden_tocitem(topic_name)

class TopicDocumentEventHandler(TopicListerDocumentEventHandler):

def doc_breadcrumbs(self, help_command, **kwargs):

doc = help_command.doc

if doc.target != 'man':

doc.write('[ ')

doc.style.sphinx_reference_label(label='cli:aws', text='aws')

doc.write(' . ')

doc.style.sphinx_reference_label(

label='cli:aws help topics',

text='topics'

)

doc.write(' ]')

def doc_title(self, help_command, **kwargs):

doc = help_command.doc

doc.style.new_paragraph()

doc.style.link_target_definition(

refname='cli:aws help %s' % self.help_command.name,

link='')

title = self._topic_tag_db.get_tag_single_value(

help_command.name, 'title')

doc.style.h1(title)

def doc_description(self, help_command, **kwargs):

doc = help_command.doc

topic_filename = os.path.join(self._topic_tag_db.topic_dir,

help_command.name + '.rst')

contents = self._remove_tags_from_content(topic_filename)

doc.writeln(contents)

doc.style.new_paragraph()

def _remove_tags_from_content(self, filename):

with open(filename, 'r') as f:

lines = f.readlines()

content_begin_index = 0

for i, line in enumerate(lines):

# If a line is encountered that does not begin with the tag

# end the search for tags and mark where tags end.

if not self._line_has_tag(line):

content_begin_index = i

break

# Join all of the non-tagged lines back together.

return ''.join(lines[content_begin_index:])

def _line_has_tag(self, line):

for tag in self._topic_tag_db.valid_tags:

if line.startswith(':' + tag + ':'):

return True

return False

def doc_subitems_start(self, help_command, **kwargs):

pass

aws-cli/awscli/clidocs.py at develop · ProGamerCode/aws-cli · GitHub

Expand file tree

Breadcrumbs

clidocs.py

Latest commit

History

Breadcrumbs

clidocs.py

File metadata and controls