Documentation overhaul for pip installation as best practice.
- Add a new section to the docs for configuring Pulsar, remove this from README. - Replace full install information in README with a very short quickstart and link to new install section of docs. - Add app.yml.sample - document parameters there instead. - Remove non-web related configuration from server.ini.sample. - Replace description in job_managers.rst with app.yml based description. - Preserve older variant of job_managers documentation as docs/job_managers_old.rst. - Add script to automatically generate RST documentation from scripts. - Add auto-generated documentation for various pulsar scripts (pulsar-main, pulsar-check, pulsar-config). - Fill out detailed option help for pulsar-check, pulsar-main, and pulsar-config. - Add manually created documentation for the puslar script. - Update pulsar-config to only present options available on current platform (e.g. no supervisor on Windows) - Many more tests for pulsar-config, comment out unreachable code. Closes #68. Closes #67. Closes #23.
Showing
- .gitignore 1 addition, 0 deletions.gitignore
- CONTRIBUTING.rst 10 additions, 11 deletionsCONTRIBUTING.rst
- README.rst 40 additions, 289 deletionsREADME.rst
- app.yml.sample 85 additions, 0 deletionsapp.yml.sample
- docs/configure.rst 149 additions, 0 deletionsdocs/configure.rst
- docs/files/job_conf_sample_mq.xml 1 addition, 1 deletiondocs/files/job_conf_sample_mq.xml
- docs/files/job_conf_sample_mq_rsync.xml 1 addition, 1 deletiondocs/files/job_conf_sample_mq_rsync.xml
- docs/files/job_conf_sample_remote_cluster.xml 1 addition, 1 deletiondocs/files/job_conf_sample_remote_cluster.xml
- docs/galaxy_conf.rst 3 additions, 3 deletionsdocs/galaxy_conf.rst
- docs/gen_scripts_doc.py 87 additions, 0 deletionsdocs/gen_scripts_doc.py
- docs/index.rst 3 additions, 0 deletionsdocs/index.rst
- docs/install.rst 78 additions, 25 deletionsdocs/install.rst
- docs/job_managers.rst 170 additions, 19 deletionsdocs/job_managers.rst
- docs/job_managers_old.rst 30 additions, 0 deletionsdocs/job_managers_old.rst
- docs/old_job_managers.ini.sample 0 additions, 0 deletionsdocs/old_job_managers.ini.sample
- docs/scripts.rst 13 additions, 0 deletionsdocs/scripts.rst
- docs/scripts/pulsar-check.rst 23 additions, 0 deletionsdocs/scripts/pulsar-check.rst
- docs/scripts/pulsar-config.rst 47 additions, 0 deletionsdocs/scripts/pulsar-config.rst
- docs/scripts/pulsar-main.rst 26 additions, 0 deletionsdocs/scripts/pulsar-main.rst
- docs/scripts/pulsar.rst 87 additions, 0 deletionsdocs/scripts/pulsar.rst
Loading
Please register or sign in to comment