Unused Documentation Infrastructure

[ZackAttack614]

The documentation.py file appears to not actually do anything. In particular, hexrd.doc_url is not a link. Do we want to remove this? If not, is there a particlar behavior we want this to have?

hexrd/hexrd/hedm/cli/documentation.py

Lines 1 to 16 in f40f031

	"""Browse documentation"""
	help = "Launches the hexrd documentation (work in progress) in a web browser"
	def configure_parser(sub_parsers):
	p = sub_parsers.add_parser('documentation', description=help, help=help)
	p.set_defaults(func=execute)
	def execute(args, parser):
	import webbrowser
	import hexrd
	webbrowser.open_new_tab(hexrd.doc_url)

[psavery]

Interesting. This documentation does show up as a subcommand when you run hexrd --help, like so:

$ hexrd --help
usage: hexrd [-h] [--debug] [--inst-profile INST_PROFILE] [--version] command ...

High energy diffraction data analysis

positional arguments:
  command
    help                Displays a list of available conda commands and their help strings.
    test                runs the hexrd test suite
    documentation       Launches the hexrd documentation (work in progress) in a web browser
    find-orientations   Process rotation image series to find grain orientations
    fit-grains          Extracts G vectors, grain position and strain
    pickle23            modify old material files (pickles) to be compatible with hexrd3; it makes a backup and
                        overwrites the original file
    preprocess          Preprocess data from detector and attach metadata

options:
  -h, --help            show this help message and exit
  --debug               verbose reporting
  --inst-profile INST_PROFILE
                        use the following files as source for functions to instrument
  --version             show program's version number and exit

But indeed, running hexrd documentation just produces an error:

AttributeError: Module `hexrd` has no attribute doc_url

We should figure out if we actually want to keep hexrd documentation as a subcommand. If we do, it should open up the user's web browser to the real documentation URL.