Function
docutils.core.publish_cmdline

Signature

publish_cmdline(reader=None, reader_name='standalone', parser=None, parser_name='restructuredtext', writer=None, writer_name='pseudoxml', settings=None, settings_spec=None, settings_overrides=None, config_section=None, enable_exit_status=1, argv=None, usage='%prog [options] [<source> [<destination>]]', description='Reads from <source> (default is stdin) and writes to <destination> (default is stdout).')

Documentation String

Set up & run a Publisher for command-line-based file I/O (input and output file paths taken automatically from the command line). Return the encoded string output also.

Parameters: see publish_programmatically for the remainder.

  • argv: Command-line argument list to use instead of sys.argv[1:].
  • usage: Usage string, output if there's a problem parsing the command line.
  • description: Program description, output for the "--help" option (along with command-line option descriptions).