Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mvdbeek committed Apr 13, 2023
1 parent f02b31d commit eea97d1
Show file tree
Hide file tree
Showing 6 changed files with 84 additions and 19 deletions.
29 changes: 19 additions & 10 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ History
.. to_doc
---------------------
0.15.0.dev3
0.15.0 (2023-04-13)
---------------------

* Updated Galaxy+Pulsar container.
* Updated Galaxy+Pulsar container. `Pull Request 306`_
* Rework container execution - generalize Kubernetes execution to allow it to work without a
message queue and to allow TES execution based on pydantic-tes (https://github.com/jmchilton/pydantic-tes).
* Add documentation and diagrams for container execution scenarios.
message queue and to allow TES execution based on pydantic-tes (https://github.com/jmchilton/pydantic-tes). `Pull Request 302`_
* Add documentation and diagrams for container execution scenarios. `Pull Request 302`_
* Rework integration tests to use pytest more aggressively.
* Fixes to CI to run more tests that weren't being executed because Tox was not sending
environment variables through to pytest.
* Add option ``amqp_key_prefix`` to direct task queue naming while retaining simple
default manager names and such in container scheduling deployments.
* Various typing and CI fixes.
* Fixes for extra_file handling
* Separate tool_stdio and job_stdio handling
* Re-import MEMORY_STATEMENT.sh from Galaxy
* Add support for logging to sentry
default manager names and such in container scheduling deployments. `Pull Request 315`_
* Various typing and CI fixes. `Pull Request 312`_, `Pull Request 319`_
* Fixes for extra_file handling. `Pull Request 318`_
* Separate tool_stdio and job_stdio handling. `Pull Request 318`_
* Re-import MEMORY_STATEMENT.sh from Galaxy. `Pull Request 297`_
* Add support for logging to sentry. `Pull Request 322`_

---------------------
0.14.16 (2022-10-04)
Expand Down Expand Up @@ -455,6 +455,15 @@ History


.. github_links
.. _Pull Request 322: https://github.com/galaxyproject/pulsar/pull/322
.. _Pull Request 318: https://github.com/galaxyproject/pulsar/pull/318
.. _Pull Request 319: https://github.com/galaxyproject/pulsar/pull/319
.. _Pull Request 312: https://github.com/galaxyproject/pulsar/pull/312
.. _Pull Request 315: https://github.com/galaxyproject/pulsar/pull/315
.. _Pull Request 306: https://github.com/galaxyproject/pulsar/pull/306
.. _Pull Request 297: https://github.com/galaxyproject/pulsar/pull/297
.. _Pull Request 302: https://github.com/galaxyproject/pulsar/pull/302
.. _Pull Request 303: https://github.com/galaxyproject/pulsar/pull/303
.. _Pull Request 301: https://github.com/galaxyproject/pulsar/pull/301
.. _Pull Request 299: https://github.com/galaxyproject/pulsar/pull/299
Expand Down
16 changes: 8 additions & 8 deletions docs/pulsar.client.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,6 @@ pulsar.client.exceptions module
:undoc-members:
:show-inheritance:

pulsar.client.interface module
------------------------------

.. automodule:: pulsar.client.interface
:members:
:undoc-members:
:show-inheritance:

pulsar.client.job\_directory module
-----------------------------------

Expand Down Expand Up @@ -117,6 +109,14 @@ pulsar.client.path\_mapper module
:undoc-members:
:show-inheritance:

pulsar.client.server\_interface module
--------------------------------------

.. automodule:: pulsar.client.server_interface
:members:
:undoc-members:
:show-inheritance:

pulsar.client.setup\_handler module
-----------------------------------

Expand Down
16 changes: 16 additions & 0 deletions docs/pulsar.managers.util.cli.job.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ pulsar.managers.util.cli.job package
Submodules
----------

pulsar.managers.util.cli.job.lsf module
---------------------------------------

.. automodule:: pulsar.managers.util.cli.job.lsf
:members:
:undoc-members:
:show-inheritance:

pulsar.managers.util.cli.job.pbs module
---------------------------------------

.. automodule:: pulsar.managers.util.cli.job.pbs
:members:
:undoc-members:
:show-inheritance:

pulsar.managers.util.cli.job.slurm module
-----------------------------------------

Expand Down
32 changes: 32 additions & 0 deletions docs/pulsar.managers.util.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Subpackages
Submodules
----------

pulsar.managers.util.aws\_batch module
--------------------------------------

.. automodule:: pulsar.managers.util.aws_batch
:members:
:undoc-members:
:show-inheritance:

pulsar.managers.util.env module
-------------------------------

Expand All @@ -38,6 +46,22 @@ pulsar.managers.util.kill module
:undoc-members:
:show-inheritance:

pulsar.managers.util.process\_groups module
-------------------------------------------

.. automodule:: pulsar.managers.util.process_groups
:members:
:undoc-members:
:show-inheritance:

pulsar.managers.util.pykube\_util module
----------------------------------------

.. automodule:: pulsar.managers.util.pykube_util
:members:
:undoc-members:
:show-inheritance:

pulsar.managers.util.retry module
---------------------------------

Expand All @@ -54,6 +78,14 @@ pulsar.managers.util.sudo module
:undoc-members:
:show-inheritance:

pulsar.managers.util.tes module
-------------------------------

.. automodule:: pulsar.managers.util.tes
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------
Expand Down
8 changes: 8 additions & 0 deletions docs/pulsar.scripts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ pulsar.scripts.drmaa\_launch module
:undoc-members:
:show-inheritance:

pulsar.scripts.finish module
----------------------------

.. automodule:: pulsar.scripts.finish
:members:
:undoc-members:
:show-inheritance:

pulsar.scripts.mesos\_executor module
-------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion pulsar/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = '0.15.0.dev3'
__version__ = '0.15.0'

PROJECT_NAME = "pulsar"
PROJECT_OWNER = PROJECT_USERAME = "galaxyproject"
Expand Down

0 comments on commit eea97d1

Please sign in to comment.