diff --git a/HISTORY.rst b/HISTORY.rst index acc9897054b931403a25b74a61fefe03cf9ac166..a743c427b32a4a1fd41a15651436ca4ab6d03edc 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -9,8 +9,21 @@ History 0.8.0.dev0 --------------------- - - +* Support new features in Galaxy job running/scripting so that Pulsar respects + ``$GALAXY_VIRTUAL_ENV`` and ``$PRESERVE_GALAXY_ENVIRONMENT``. Fix remote + metadata in cases where the tool environment changes the ``python`` on + ``$PATH``. `Pull Request 137`_ +* Precreate Galaxy tool outputs on the remote before executing (fixes a bug + related to missing output files on stage out). `Pull Request 141`_ +* Support the remote_transfer file action without setting the + ``jobs_directory`` destination param `Pull Request 136`_ +* Fix invalid character in job managers documentation (thanks to @mapa17). + `Pull Request 130`_ +* Fix ``conda_auto_*`` option resolution and include a sample + ``dependency_resolvers_conf.xml`` (thanks to @mapa17). `Pull Request 132`_ +* Fix tox/Travis tests. `Pull Request 138`_, `Pull Request 139`_, + `Pull Request 140`_ +* Fix a bug with AMQP acknowledgement. `Pull Request 143`_ --------------------- 0.7.4 (2017-02-07) @@ -148,6 +161,15 @@ History .. github_links +.. _Pull Request 143: https://github.com/galaxyproject/pulsar/pull/143 +.. _Pull Request 141: https://github.com/galaxyproject/pulsar/pull/141 +.. _Pull Request 136: https://github.com/galaxyproject/pulsar/pull/136 +.. _Pull Request 137: https://github.com/galaxyproject/pulsar/pull/137 +.. _Pull Request 140: https://github.com/galaxyproject/pulsar/pull/140 +.. _Pull Request 139: https://github.com/galaxyproject/pulsar/pull/139 +.. _Pull Request 138: https://github.com/galaxyproject/pulsar/pull/138 +.. _Pull Request 132: https://github.com/galaxyproject/pulsar/pull/132 +.. _Pull Request 130: https://github.com/galaxyproject/pulsar/pull/130 .. _11ce744: https://github.com/galaxyproject/pulsar/commit/11ce744 .. _3573341: https://github.com/galaxyproject/pulsar/commit/3573341 .. _93ab8a1: https://github.com/galaxyproject/pulsar/commit/93ab8a1 diff --git a/Makefile b/Makefile index 26bc3790417d0dbee0516000de54897ba6f15cc7..1e8c3184a4a933d7381a92df7428e15c38e84f4c 100644 --- a/Makefile +++ b/Makefile @@ -122,7 +122,7 @@ open-project: open $(PROJECT_URL) || xdg-open $(PROJECT_URL) dist: clean - $(IN_VENV) python setup.py sdist bdist_egg bdist_wheel + $(IN_VENV) python setup.py sdist bdist_wheel ls -l dist _release-test-artifacts: @@ -133,7 +133,7 @@ dist-all: dist _dist-lib release-test-artifacts: dist-all _release-test-artifacts -_release-aritfacts: +_release-artifacts: @while [ -z "$$CONTINUE" ]; do \ read -r -p "Have you executed release-test and reviewed results? [y/N]: " CONTINUE; \ done ; \ @@ -141,7 +141,7 @@ _release-aritfacts: @echo "Releasing" $(IN_VENV) twine upload dist/* -release-aritfacts: release-test-artifacts _release-aritfacts +release-artifacts: release-test-artifacts _release-artifacts commit-version: $(IN_VENV) python $(BUILD_SCRIPTS_DIR)/commit_version.py $(SOURCE_DIR) $(VERSION) @@ -149,7 +149,7 @@ commit-version: new-version: $(IN_VENV) python $(BUILD_SCRIPTS_DIR)/new_version.py $(SOURCE_DIR) $(VERSION) -release-local: commit-version release-aritfacts new-version +release-local: commit-version release-artifacts new-version push-release: git push $(UPSTREAM) master @@ -161,10 +161,10 @@ add-history: $(IN_VENV) python $(BUILD_SCRIPTS_DIR)/bootstrap_history.py $(ITEM) _dist-lib: - $(IN_VENV) PULSAR_GALAXY_LIB=1 python setup.py sdist bdist_egg bdist_wheel + $(IN_VENV) PULSAR_GALAXY_LIB=1 python setup.py sdist bdist_wheel ls -l dist dist-lib: clean _dist-lib #release-test-lib-artifacts: dist-lib _release-test-artifacts -#release-lib-aritfacts: release-test-lib-artifacts _release-aritfacts +#release-lib-artifacts: release-test-lib-artifacts _release-artifacts diff --git a/docs/developing.rst b/docs/developing.rst index e812327b9305bcf3ecc980c3ea50ffd6c8cd7d2e..9ddf5263d767385ac955ad1425f7eea84b083a9f 100644 --- a/docs/developing.rst +++ b/docs/developing.rst @@ -33,12 +33,19 @@ are fine. * Review ``git status`` for missing files. * Verify the latest Travis CI builds pass. * ``make open-docs`` and review changelog. +* Ensure the target release is set correctly in ``pulsar/__init__.py`` + (``version`` will be a ``devN`` variant of target release). * ``make clean && make lint && make tests`` -* ``python tools/commit_version.py <new_version>`` * ``make release`` - * Review `Test PyPI site <https://testpypi.python.org/pypi/pulsar-app>`_ - for errors. - * Test intall ``pip install -i https://testpypi.python.org/pypi pulsar-app``. -* ``python tools/new_version.py <new_version>`` -* ``git push origin master`` -* ``git push --tags origin`` + + * Review `Test PyPI site <https://testpypi.python.org/pypi/pulsar-app>`_ + for errors. + * Test intall ``pip install -i https://testpypi.python.org/pypi pulsar-app``. + + This process will push packages to test PyPI, allow review, publish + to production PyPI, tag the git repository, and push the tag upstream. + If changes are needed, this can be broken down into steps + such as: + + * ``make release-local`` + * ``make push-release`` diff --git a/docs/pulsar.cache.rst b/docs/pulsar.cache.rst index ccfe4b0576e77aed4fa1dc6d26b9ecf706f7e166..f729d5f47cb171e583eb6b1df31b825949816e65 100644 --- a/docs/pulsar.cache.rst +++ b/docs/pulsar.cache.rst @@ -1,19 +1,19 @@ -pulsar.cache package -==================== +pulsar\.cache package +===================== Submodules ---------- -pulsar.cache.persistence module -------------------------------- +pulsar\.cache\.persistence module +--------------------------------- .. automodule:: pulsar.cache.persistence :members: :undoc-members: :show-inheritance: -pulsar.cache.util module ------------------------- +pulsar\.cache\.util module +-------------------------- .. automodule:: pulsar.cache.util :members: diff --git a/docs/pulsar.client.rst b/docs/pulsar.client.rst index 6fa8e958aa32e0b194f38c96bd9d9d9efeba6348..01fc75ee248b8a4cf2a58874b02f4b841d84f634 100644 --- a/docs/pulsar.client.rst +++ b/docs/pulsar.client.rst @@ -1,5 +1,5 @@ -pulsar.client package -===================== +pulsar\.client package +====================== Subpackages ----------- @@ -13,112 +13,120 @@ Subpackages Submodules ---------- -pulsar.client.action_mapper module ----------------------------------- +pulsar\.client\.action\_mapper module +------------------------------------- .. automodule:: pulsar.client.action_mapper :members: :undoc-members: :show-inheritance: -pulsar.client.amqp_exchange module ----------------------------------- +pulsar\.client\.amqp\_exchange module +------------------------------------- .. automodule:: pulsar.client.amqp_exchange :members: :undoc-members: :show-inheritance: -pulsar.client.amqp_exchange_factory module ------------------------------------------- +pulsar\.client\.amqp\_exchange\_factory module +---------------------------------------------- .. automodule:: pulsar.client.amqp_exchange_factory :members: :undoc-members: :show-inheritance: -pulsar.client.client module ---------------------------- +pulsar\.client\.client module +----------------------------- .. automodule:: pulsar.client.client :members: :undoc-members: :show-inheritance: -pulsar.client.config_util module --------------------------------- +pulsar\.client\.config\_util module +----------------------------------- .. automodule:: pulsar.client.config_util :members: :undoc-members: :show-inheritance: -pulsar.client.decorators module -------------------------------- +pulsar\.client\.decorators module +--------------------------------- .. automodule:: pulsar.client.decorators :members: :undoc-members: :show-inheritance: -pulsar.client.destination module --------------------------------- +pulsar\.client\.destination module +---------------------------------- .. automodule:: pulsar.client.destination :members: :undoc-members: :show-inheritance: -pulsar.client.interface module ------------------------------- +pulsar\.client\.exceptions module +--------------------------------- + +.. automodule:: pulsar.client.exceptions + :members: + :undoc-members: + :show-inheritance: + +pulsar\.client\.interface module +-------------------------------- .. automodule:: pulsar.client.interface :members: :undoc-members: :show-inheritance: -pulsar.client.job_directory module ----------------------------------- +pulsar\.client\.job\_directory module +------------------------------------- .. automodule:: pulsar.client.job_directory :members: :undoc-members: :show-inheritance: -pulsar.client.manager module ----------------------------- +pulsar\.client\.manager module +------------------------------ .. automodule:: pulsar.client.manager :members: :undoc-members: :show-inheritance: -pulsar.client.object_client module ----------------------------------- +pulsar\.client\.object\_client module +------------------------------------- .. automodule:: pulsar.client.object_client :members: :undoc-members: :show-inheritance: -pulsar.client.path_mapper module --------------------------------- +pulsar\.client\.path\_mapper module +----------------------------------- .. automodule:: pulsar.client.path_mapper :members: :undoc-members: :show-inheritance: -pulsar.client.setup_handler module ----------------------------------- +pulsar\.client\.setup\_handler module +------------------------------------- .. automodule:: pulsar.client.setup_handler :members: :undoc-members: :show-inheritance: -pulsar.client.util module -------------------------- +pulsar\.client\.util module +--------------------------- .. automodule:: pulsar.client.util :members: diff --git a/docs/pulsar.client.staging.rst b/docs/pulsar.client.staging.rst index 98dc2c4cd44ec369b1b53fc0a1ed4f1c72df9711..d8ca98108d3afc2c13347ae2da97c297a547b7f5 100644 --- a/docs/pulsar.client.staging.rst +++ b/docs/pulsar.client.staging.rst @@ -1,19 +1,19 @@ -pulsar.client.staging package -============================= +pulsar\.client\.staging package +=============================== Submodules ---------- -pulsar.client.staging.down module ---------------------------------- +pulsar\.client\.staging\.down module +------------------------------------ .. automodule:: pulsar.client.staging.down :members: :undoc-members: :show-inheritance: -pulsar.client.staging.up module -------------------------------- +pulsar\.client\.staging\.up module +---------------------------------- .. automodule:: pulsar.client.staging.up :members: diff --git a/docs/pulsar.client.test.rst b/docs/pulsar.client.test.rst index a28c7990f0bb6dd02c63d204f7952e8d25d1b2b3..79b013c515fd5fdd0ff7e7330fd6c4b7cc62ebcc 100644 --- a/docs/pulsar.client.test.rst +++ b/docs/pulsar.client.test.rst @@ -1,19 +1,19 @@ -pulsar.client.test package -========================== +pulsar\.client\.test package +============================ Submodules ---------- -pulsar.client.test.check module -------------------------------- +pulsar\.client\.test\.check module +---------------------------------- .. automodule:: pulsar.client.test.check :members: :undoc-members: :show-inheritance: -pulsar.client.test.test_common module -------------------------------------- +pulsar\.client\.test\.test\_common module +----------------------------------------- .. automodule:: pulsar.client.test.test_common :members: diff --git a/docs/pulsar.client.transport.rst b/docs/pulsar.client.transport.rst index c637585aa5edd8e6e6ca5e8954a3b7d83e1d3f60..c727d63650bbebc0744c7036b5a0160ebc052982 100644 --- a/docs/pulsar.client.transport.rst +++ b/docs/pulsar.client.transport.rst @@ -1,43 +1,43 @@ -pulsar.client.transport package -=============================== +pulsar\.client\.transport package +================================= Submodules ---------- -pulsar.client.transport.curl module ------------------------------------ +pulsar\.client\.transport\.curl module +-------------------------------------- .. automodule:: pulsar.client.transport.curl :members: :undoc-members: :show-inheritance: -pulsar.client.transport.poster module -------------------------------------- +pulsar\.client\.transport\.poster module +---------------------------------------- .. automodule:: pulsar.client.transport.poster :members: :undoc-members: :show-inheritance: -pulsar.client.transport.requests module ---------------------------------------- +pulsar\.client\.transport\.requests module +------------------------------------------ .. automodule:: pulsar.client.transport.requests :members: :undoc-members: :show-inheritance: -pulsar.client.transport.ssh module ----------------------------------- +pulsar\.client\.transport\.ssh module +------------------------------------- .. automodule:: pulsar.client.transport.ssh :members: :undoc-members: :show-inheritance: -pulsar.client.transport.standard module ---------------------------------------- +pulsar\.client\.transport\.standard module +------------------------------------------ .. automodule:: pulsar.client.transport.standard :members: diff --git a/docs/pulsar.managers.base.rst b/docs/pulsar.managers.base.rst index 80da3cbadc80e001133aa9b72b90d2bebc7db0a8..c700e9f2ec16924efcea6989933a10e8c525e4ab 100644 --- a/docs/pulsar.managers.base.rst +++ b/docs/pulsar.managers.base.rst @@ -1,27 +1,27 @@ -pulsar.managers.base package -============================ +pulsar\.managers\.base package +============================== Submodules ---------- -pulsar.managers.base.base_drmaa module --------------------------------------- +pulsar\.managers\.base\.base\_drmaa module +------------------------------------------ .. automodule:: pulsar.managers.base.base_drmaa :members: :undoc-members: :show-inheritance: -pulsar.managers.base.directory module -------------------------------------- +pulsar\.managers\.base\.directory module +---------------------------------------- .. automodule:: pulsar.managers.base.directory :members: :undoc-members: :show-inheritance: -pulsar.managers.base.external module ------------------------------------- +pulsar\.managers\.base\.external module +--------------------------------------- .. automodule:: pulsar.managers.base.external :members: diff --git a/docs/pulsar.managers.rst b/docs/pulsar.managers.rst index 3b204506a085c7f345512f3631b215c21818b3b5..ff4e9581e3eade4441c53ca52a8a6c1c809e802a 100644 --- a/docs/pulsar.managers.rst +++ b/docs/pulsar.managers.rst @@ -1,5 +1,5 @@ -pulsar.managers package -======================= +pulsar\.managers package +======================== Subpackages ----------- @@ -13,80 +13,80 @@ Subpackages Submodules ---------- -pulsar.managers.queued module ------------------------------ +pulsar\.managers\.queued module +------------------------------- .. automodule:: pulsar.managers.queued :members: :undoc-members: :show-inheritance: -pulsar.managers.queued_cli module ---------------------------------- +pulsar\.managers\.queued\_cli module +------------------------------------ .. automodule:: pulsar.managers.queued_cli :members: :undoc-members: :show-inheritance: -pulsar.managers.queued_condor module ------------------------------------- +pulsar\.managers\.queued\_condor module +--------------------------------------- .. automodule:: pulsar.managers.queued_condor :members: :undoc-members: :show-inheritance: -pulsar.managers.queued_drmaa module ------------------------------------ +pulsar\.managers\.queued\_drmaa module +-------------------------------------- .. automodule:: pulsar.managers.queued_drmaa :members: :undoc-members: :show-inheritance: -pulsar.managers.queued_drmaa_xsede module ------------------------------------------ +pulsar\.managers\.queued\_drmaa\_xsede module +--------------------------------------------- .. automodule:: pulsar.managers.queued_drmaa_xsede :members: :undoc-members: :show-inheritance: -pulsar.managers.queued_external_drmaa module --------------------------------------------- +pulsar\.managers\.queued\_external\_drmaa module +------------------------------------------------ .. automodule:: pulsar.managers.queued_external_drmaa :members: :undoc-members: :show-inheritance: -pulsar.managers.queued_pbs module ---------------------------------- +pulsar\.managers\.queued\_pbs module +------------------------------------ .. automodule:: pulsar.managers.queued_pbs :members: :undoc-members: :show-inheritance: -pulsar.managers.stateful module -------------------------------- +pulsar\.managers\.stateful module +--------------------------------- .. automodule:: pulsar.managers.stateful :members: :undoc-members: :show-inheritance: -pulsar.managers.status module ------------------------------ +pulsar\.managers\.status module +------------------------------- .. automodule:: pulsar.managers.status :members: :undoc-members: :show-inheritance: -pulsar.managers.unqueued module -------------------------------- +pulsar\.managers\.unqueued module +--------------------------------- .. automodule:: pulsar.managers.unqueued :members: diff --git a/docs/pulsar.managers.staging.rst b/docs/pulsar.managers.staging.rst index 0f14f5af3b7723ee03e46e10a8fa277cede6e1de..8931c67d126d7ce359f67723dbb026187809f007 100644 --- a/docs/pulsar.managers.staging.rst +++ b/docs/pulsar.managers.staging.rst @@ -1,19 +1,19 @@ -pulsar.managers.staging package -=============================== +pulsar\.managers\.staging package +================================= Submodules ---------- -pulsar.managers.staging.post module ------------------------------------ +pulsar\.managers\.staging\.post module +-------------------------------------- .. automodule:: pulsar.managers.staging.post :members: :undoc-members: :show-inheritance: -pulsar.managers.staging.pre module ----------------------------------- +pulsar\.managers\.staging\.pre module +------------------------------------- .. automodule:: pulsar.managers.staging.pre :members: diff --git a/docs/pulsar.managers.util.cli.job.rst b/docs/pulsar.managers.util.cli.job.rst index 51ff14d7ee97e911eed68e3e58cd2381fa907bac..cad20090a88363234df486b8a5762b74dae7dadd 100644 --- a/docs/pulsar.managers.util.cli.job.rst +++ b/docs/pulsar.managers.util.cli.job.rst @@ -1,27 +1,27 @@ -pulsar.managers.util.cli.job package -==================================== +pulsar\.managers\.util\.cli\.job package +======================================== Submodules ---------- -pulsar.managers.util.cli.job.slurm module ------------------------------------------ +pulsar\.managers\.util\.cli\.job\.slurm module +---------------------------------------------- .. automodule:: pulsar.managers.util.cli.job.slurm :members: :undoc-members: :show-inheritance: -pulsar.managers.util.cli.job.slurm_torque module ------------------------------------------------- +pulsar\.managers\.util\.cli\.job\.slurm\_torque module +------------------------------------------------------ .. automodule:: pulsar.managers.util.cli.job.slurm_torque :members: :undoc-members: :show-inheritance: -pulsar.managers.util.cli.job.torque module ------------------------------------------- +pulsar\.managers\.util\.cli\.job\.torque module +----------------------------------------------- .. automodule:: pulsar.managers.util.cli.job.torque :members: diff --git a/docs/pulsar.managers.util.cli.rst b/docs/pulsar.managers.util.cli.rst index 39130e8df86bc723e0b91b5bd7be1c7633843b57..b5b2b6bb8228e00863d5d6bb8f47d6dac061984e 100644 --- a/docs/pulsar.managers.util.cli.rst +++ b/docs/pulsar.managers.util.cli.rst @@ -1,5 +1,5 @@ -pulsar.managers.util.cli package -================================ +pulsar\.managers\.util\.cli package +=================================== Subpackages ----------- @@ -12,8 +12,8 @@ Subpackages Submodules ---------- -pulsar.managers.util.cli.factory module ---------------------------------------- +pulsar\.managers\.util\.cli\.factory module +------------------------------------------- .. automodule:: pulsar.managers.util.cli.factory :members: diff --git a/docs/pulsar.managers.util.cli.shell.rst b/docs/pulsar.managers.util.cli.shell.rst index c9a387229c743d0c4e3ba141e444b717612aa398..7be4bb9a5de71f997a8a86fb464515afa650787b 100644 --- a/docs/pulsar.managers.util.cli.shell.rst +++ b/docs/pulsar.managers.util.cli.shell.rst @@ -1,19 +1,19 @@ -pulsar.managers.util.cli.shell package -====================================== +pulsar\.managers\.util\.cli\.shell package +========================================== Submodules ---------- -pulsar.managers.util.cli.shell.local module -------------------------------------------- +pulsar\.managers\.util\.cli\.shell\.local module +------------------------------------------------ .. automodule:: pulsar.managers.util.cli.shell.local :members: :undoc-members: :show-inheritance: -pulsar.managers.util.cli.shell.rsh module ------------------------------------------ +pulsar\.managers\.util\.cli\.shell\.rsh module +---------------------------------------------- .. automodule:: pulsar.managers.util.cli.shell.rsh :members: diff --git a/docs/pulsar.managers.util.condor.rst b/docs/pulsar.managers.util.condor.rst index c99f10c7c65c837710de4b325b1ee12f44563a0e..e3af0bc7b78218abb6662d98d0e481d2f293ff46 100644 --- a/docs/pulsar.managers.util.condor.rst +++ b/docs/pulsar.managers.util.condor.rst @@ -1,5 +1,5 @@ -pulsar.managers.util.condor package -=================================== +pulsar\.managers\.util\.condor package +====================================== Module contents --------------- diff --git a/docs/pulsar.managers.util.drmaa.rst b/docs/pulsar.managers.util.drmaa.rst index 3ac16f8875e4ecb7cd63f14f009a2e93833c250a..e4c7ecfd24a098d90b62d172200476f7ba19cc52 100644 --- a/docs/pulsar.managers.util.drmaa.rst +++ b/docs/pulsar.managers.util.drmaa.rst @@ -1,5 +1,5 @@ -pulsar.managers.util.drmaa package -================================== +pulsar\.managers\.util\.drmaa package +===================================== Module contents --------------- diff --git a/docs/pulsar.managers.util.job_script.rst b/docs/pulsar.managers.util.job_script.rst index 8bd69539329c4f832b959b38ca5263064a58afce..913a1fda32d1bf1d64a4ea082bf69ec1180795e6 100644 --- a/docs/pulsar.managers.util.job_script.rst +++ b/docs/pulsar.managers.util.job_script.rst @@ -1,5 +1,5 @@ -pulsar.managers.util.job_script package -======================================= +pulsar\.managers\.util\.job\_script package +=========================================== Module contents --------------- diff --git a/docs/pulsar.managers.util.rst b/docs/pulsar.managers.util.rst index d970ed3df1818e5b498f78956e6e29b13db4f902..1893800c9c8a44588c2bcb44ef230fc3323dba24 100644 --- a/docs/pulsar.managers.util.rst +++ b/docs/pulsar.managers.util.rst @@ -1,5 +1,5 @@ -pulsar.managers.util package -============================ +pulsar\.managers\.util package +============================== Subpackages ----------- @@ -14,40 +14,40 @@ Subpackages Submodules ---------- -pulsar.managers.util.env module -------------------------------- +pulsar\.managers\.util\.env module +---------------------------------- .. automodule:: pulsar.managers.util.env :members: :undoc-members: :show-inheritance: -pulsar.managers.util.external module ------------------------------------- +pulsar\.managers\.util\.external module +--------------------------------------- .. automodule:: pulsar.managers.util.external :members: :undoc-members: :show-inheritance: -pulsar.managers.util.kill module --------------------------------- +pulsar\.managers\.util\.kill module +----------------------------------- .. automodule:: pulsar.managers.util.kill :members: :undoc-members: :show-inheritance: -pulsar.managers.util.retry module ---------------------------------- +pulsar\.managers\.util\.retry module +------------------------------------ .. automodule:: pulsar.managers.util.retry :members: :undoc-members: :show-inheritance: -pulsar.managers.util.sudo module --------------------------------- +pulsar\.managers\.util\.sudo module +----------------------------------- .. automodule:: pulsar.managers.util.sudo :members: diff --git a/docs/pulsar.mesos.rst b/docs/pulsar.mesos.rst index 9ffefb4ff4968dfb3bc0332ef67bb7126bb93e78..62e88a06bebeb6eed479bc45b1d04fff37a82a64 100644 --- a/docs/pulsar.mesos.rst +++ b/docs/pulsar.mesos.rst @@ -1,11 +1,11 @@ -pulsar.mesos package -==================== +pulsar\.mesos package +===================== Submodules ---------- -pulsar.mesos.framework module ------------------------------ +pulsar\.mesos\.framework module +------------------------------- .. automodule:: pulsar.mesos.framework :members: diff --git a/docs/pulsar.messaging.rst b/docs/pulsar.messaging.rst index aeec6f66077f70cd8c6d8905e15a6a5231909d4d..7f164d3502b273b3015d63a94e09833558fa73b3 100644 --- a/docs/pulsar.messaging.rst +++ b/docs/pulsar.messaging.rst @@ -1,11 +1,11 @@ -pulsar.messaging package -======================== +pulsar\.messaging package +========================= Submodules ---------- -pulsar.messaging.bind_amqp module ---------------------------------- +pulsar\.messaging\.bind\_amqp module +------------------------------------ .. automodule:: pulsar.messaging.bind_amqp :members: diff --git a/docs/pulsar.rst b/docs/pulsar.rst index b6f8483100950395991de5583f601aa6cfe5c416..4f5d6d84d9bf464f9e6dbe4f7f07b245a94e0c24 100644 --- a/docs/pulsar.rst +++ b/docs/pulsar.rst @@ -19,40 +19,40 @@ Subpackages Submodules ---------- -pulsar.core module ------------------- +pulsar\.core module +------------------- .. automodule:: pulsar.core :members: :undoc-members: :show-inheritance: -pulsar.locks module -------------------- +pulsar\.locks module +-------------------- .. automodule:: pulsar.locks :members: :undoc-members: :show-inheritance: -pulsar.main module ------------------- +pulsar\.main module +------------------- .. automodule:: pulsar.main :members: :undoc-members: :show-inheritance: -pulsar.manager_endpoint_util module ------------------------------------ +pulsar\.manager\_endpoint\_util module +-------------------------------------- .. automodule:: pulsar.manager_endpoint_util :members: :undoc-members: :show-inheritance: -pulsar.manager_factory module ------------------------------ +pulsar\.manager\_factory module +------------------------------- .. automodule:: pulsar.manager_factory :members: diff --git a/docs/pulsar.scripts.rst b/docs/pulsar.scripts.rst index 865f6d4475f70b9dd18c3f2ea4b8d931b4738ac7..0507d96fc72ac812829f9cf8cc83348f0d8d1e1e 100644 --- a/docs/pulsar.scripts.rst +++ b/docs/pulsar.scripts.rst @@ -1,75 +1,75 @@ -pulsar.scripts package -====================== +pulsar\.scripts package +======================= Submodules ---------- -pulsar.scripts.chown_working_directory module ---------------------------------------------- +pulsar\.scripts\.chown\_working\_directory module +------------------------------------------------- .. automodule:: pulsar.scripts.chown_working_directory :members: :undoc-members: :show-inheritance: -pulsar.scripts.config module ----------------------------- +pulsar\.scripts\.config module +------------------------------ .. automodule:: pulsar.scripts.config :members: :undoc-members: :show-inheritance: -pulsar.scripts.drmaa_kill module --------------------------------- +pulsar\.scripts\.drmaa\_kill module +----------------------------------- .. automodule:: pulsar.scripts.drmaa_kill :members: :undoc-members: :show-inheritance: -pulsar.scripts.drmaa_launch module ----------------------------------- +pulsar\.scripts\.drmaa\_launch module +------------------------------------- .. automodule:: pulsar.scripts.drmaa_launch :members: :undoc-members: :show-inheritance: -pulsar.scripts.mesos_executor module ------------------------------------- +pulsar\.scripts\.mesos\_executor module +--------------------------------------- .. automodule:: pulsar.scripts.mesos_executor :members: :undoc-members: :show-inheritance: -pulsar.scripts.mesos_framework module -------------------------------------- +pulsar\.scripts\.mesos\_framework module +---------------------------------------- .. automodule:: pulsar.scripts.mesos_framework :members: :undoc-members: :show-inheritance: -pulsar.scripts.run module -------------------------- +pulsar\.scripts\.run module +--------------------------- .. automodule:: pulsar.scripts.run :members: :undoc-members: :show-inheritance: -pulsar.scripts.submit module ----------------------------- +pulsar\.scripts\.submit module +------------------------------ .. automodule:: pulsar.scripts.submit :members: :undoc-members: :show-inheritance: -pulsar.scripts.submit_util module ---------------------------------- +pulsar\.scripts\.submit\_util module +------------------------------------ .. automodule:: pulsar.scripts.submit_util :members: diff --git a/docs/pulsar.tools.rst b/docs/pulsar.tools.rst index ee94cca8fd38ebf7981673739b1a27843e0de9db..a514adb4ea4dbba8d7ed8c3e3f5a0560dbbc88b7 100644 --- a/docs/pulsar.tools.rst +++ b/docs/pulsar.tools.rst @@ -1,27 +1,27 @@ -pulsar.tools package -==================== +pulsar\.tools package +===================== Submodules ---------- -pulsar.tools.authorization module ---------------------------------- +pulsar\.tools\.authorization module +----------------------------------- .. automodule:: pulsar.tools.authorization :members: :undoc-members: :show-inheritance: -pulsar.tools.toolbox module ---------------------------- +pulsar\.tools\.toolbox module +----------------------------- .. automodule:: pulsar.tools.toolbox :members: :undoc-members: :show-inheritance: -pulsar.tools.validator module ------------------------------ +pulsar\.tools\.validator module +------------------------------- .. automodule:: pulsar.tools.validator :members: diff --git a/docs/pulsar.util.pastescript.rst b/docs/pulsar.util.pastescript.rst new file mode 100644 index 0000000000000000000000000000000000000000..c12b6c1ca8b1a88a3f5391b9660693a17bc1a14f --- /dev/null +++ b/docs/pulsar.util.pastescript.rst @@ -0,0 +1,30 @@ +pulsar\.util\.pastescript package +================================= + +Submodules +---------- + +pulsar\.util\.pastescript\.loadwsgi module +------------------------------------------ + +.. automodule:: pulsar.util.pastescript.loadwsgi + :members: + :undoc-members: + :show-inheritance: + +pulsar\.util\.pastescript\.serve module +--------------------------------------- + +.. automodule:: pulsar.util.pastescript.serve + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: pulsar.util.pastescript + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pulsar.util.rst b/docs/pulsar.util.rst index 6134680b5bb8a8f999995ba416c006cd2111998f..739df1542f1d837acdf10a9c5bb2e02dd6fefef7 100644 --- a/docs/pulsar.util.rst +++ b/docs/pulsar.util.rst @@ -1,5 +1,12 @@ -pulsar.util package -=================== +pulsar\.util package +==================== + +Subpackages +----------- + +.. toctree:: + + pulsar.util.pastescript Module contents --------------- diff --git a/docs/pulsar.web.rst b/docs/pulsar.web.rst index 1cd31da7b6bd01477c889704060219275186d0a8..a78cde9fd22690083128c944002eed000a69d5c2 100644 --- a/docs/pulsar.web.rst +++ b/docs/pulsar.web.rst @@ -1,27 +1,27 @@ -pulsar.web package -================== +pulsar\.web package +=================== Submodules ---------- -pulsar.web.framework module ---------------------------- +pulsar\.web\.framework module +----------------------------- .. automodule:: pulsar.web.framework :members: :undoc-members: :show-inheritance: -pulsar.web.routes module ------------------------- +pulsar\.web\.routes module +-------------------------- .. automodule:: pulsar.web.routes :members: :undoc-members: :show-inheritance: -pulsar.web.wsgi module ----------------------- +pulsar\.web\.wsgi module +------------------------ .. automodule:: pulsar.web.wsgi :members: