• Language: en

popy_doc

For convenient access to PoPy’s documentation, Open a PoPy Command Prompt and type:-

$ popy_doc

This opens the The PoPy Manual HTML documentation page.

Examples

You can access the online documentation as follows (default is locally installed .html files):-

$ popy_doc -o

Alternatively you can open documentation for a specific tool (e.g., popy_run) with the -t or –tool option:-

$ popy_doc --tool run

You can also open documentation for specific Script File Formats (e.g., a Fit Script) with the -s or –script option:-

$ popy_doc --script fit

Command line options

usage: popy_doc [-h] [-o]
                [-s {none,fit,fitsum,gen,gensum,grph,n2pdat,p2ndat,msim,rst,sim,sumdoc,tut,tutsum,val,vpc,mfit,mgen,mtut,mcomp,cmd,comp,nmpi,merge}]
                [-t {none,activate,create,check,deactivate,doc,edit,env,fix,info,run}]

Opens PoPy html documentation in web browser.

optional arguments:
  -h, --help            show this help message and exit
  -o, --online          Optionally access online documentation instead of
                        local.
  -s {none,fit,fitsum,gen,gensum,grph,n2pdat,p2ndat,msim,rst,sim,sumdoc,tut,tutsum,val,vpc,mfit,mgen,mtut,mcomp,cmd,comp,nmpi,merge}, --script {none,fit,fitsum,gen,gensum,grph,n2pdat,p2ndat,msim,rst,sim,sumdoc,tut,tutsum,val,vpc,mfit,mgen,mtut,mcomp,cmd,comp,nmpi,merge}
                        Optionally open documentation for a specific script
                        type.
  -t {none,activate,create,check,deactivate,doc,edit,env,fix,info,run}, --tool {none,activate,create,check,deactivate,doc,edit,env,fix,info,run}
                        Optionally open documentation for a specific PoPy tool
popy_edit
popy_view
Back to Top