Skip to content

Commit

Permalink
Fixes some docs formatting issues discovered with Sphinx 4.3.0
Browse files Browse the repository at this point in the history
[noissue]
  • Loading branch information
dkliban committed Dec 2, 2021
1 parent c2bb4c1 commit fe3a78a
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 23 deletions.
41 changes: 23 additions & 18 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,8 @@ Features
.. warning::

If you intend to stick with the old tasking system, you should configure the
``USE_NEW_WORKER_TYPE`` setting to false before upgrading.
``USE_NEW_WORKER_TYPE`` setting to false before upgrade

`#8948 <https://pulp.plan.io/issues/8948>`_


Expand Down Expand Up @@ -1099,15 +1100,15 @@ Features
`#8357 <https://pulp.plan.io/issues/8357>`_
- Added the following new objects related to a new ``Distribution`` MasterModel:
* ``pulpcore.plugin.models.Distribution`` - A new MasterModel ``Distribution`` which replaces the
``pulpcore.plugin.models.BaseDistribution``. This now contains the ``repository``,
``repository_version``, and ``publication`` fields on the MasterModel instead of on the detail
models as was done with ``pulpcore.plugin.models.BaseDistribution``.
``pulpcore.plugin.models.BaseDistribution``. This now contains the ``repository``,
``repository_version``, and ``publication`` fields on the MasterModel instead of on the detail
models as was done with ``pulpcore.plugin.models.BaseDistribution``.
* ``pulpcore.plugin.serializer.DistributionSerializer`` - A serializer plugin writers should use
with the new ``pulpcore.plugin.models.Distribution``.
with the new ``pulpcore.plugin.models.Distribution``.
* ``pulpcore.plugin.viewset.DistributionViewSet`` - The viewset that replaces the deprecated
``pulpcore.plugin.viewset.BaseDistributionViewSet``.
``pulpcore.plugin.viewset.BaseDistributionViewSet``.
* ``pulpcore.plugin.viewset.NewDistributionFilter`` - The filter that pairs with the
``Distribution`` model.
``Distribution`` model.
`#8384 <https://pulp.plan.io/issues/8384>`_
- Added checksum type enforcement to ``pulpcore.plugin.download.BaseDownloader``.
`#8435 <https://pulp.plan.io/issues/8435>`_
Expand Down Expand Up @@ -1140,25 +1141,26 @@ Deprecations

- The following objects were deprecated:
* ``pulpcore.plugin.models.BaseDistribution`` -- Instead use
``pulpcore.plugin.models.Distribution``.
``pulpcore.plugin.models.Distribution``.
* ``pulpcore.plugin.viewset.BaseDistributionViewSet`` -- Instead use
``pulpcore.plugin.viewset.DistributionViewSet``.
``pulpcore.plugin.viewset.DistributionViewSet``.
* ``pulpcore.plugin.serializer.BaseDistributionSerializer`` -- Instead use
``pulpcore.plugin.serializer.DistributionSerializer``.
``pulpcore.plugin.serializer.DistributionSerializer``.
* ``pulpcore.plugin.serializer.PublicationDistributionSerializer`` -- Instead use define the
``publication`` field directly on your detail distribution object. See the docstring for
``pulpcore.plugin.serializer.DistributionSerializer`` for an example.
``publication`` field directly on your detail distribution object. See the docstring for
``pulpcore.plugin.serializer.DistributionSerializer`` for an example.
* ``pulpcore.plugin.serializer.RepositoryVersionDistributionSerializer`` -- Instead use define the
``repository_version`` field directly on your detail distribution object. See the docstring for
``pulpcore.plugin.serializer.DistributionSerializer`` for an example.
``repository_version`` field directly on your detail distribution object. See the docstring for
``pulpcore.plugin.serializer.DistributionSerializer`` for an example.
* ``pulpcore.plugin.viewset.DistributionFilter`` -- Instead use
``pulpcore.plugin.viewset.NewDistributionFilter``.
``pulpcore.plugin.viewset.NewDistributionFilter``.

.. note::

You will have to define a migration to move your data from
``pulpcore.plugin.models.BaseDistribution`` to ``pulpcore.plugin.models.Distribution``. See the
pulp_file migration 0009 as a reference example.

`#8385 <https://pulp.plan.io/issues/8385>`_
- Deprecated the ``pulpcore.plugin.tasking.enqueue_with_reservation``. Instead use the
``pulpcore.plugin.tasking.dispatch`` interface.
Expand All @@ -1169,7 +1171,9 @@ Deprecations
`#8505 <https://pulp.plan.io/issues/8505>`_


3.11.2 (2021-05-25)REST API
3.11.2 (2021-05-25)
===================
REST API
--------

Bugfixes
Expand Down Expand Up @@ -1200,7 +1204,7 @@ REST API
--------

Bugfixes
~~~~~~~
~~~~~~~~

- Fixed a race condition that sometimes surfaced during handling of reserved resources.
`#8632 <https://pulp.plan.io/issues/8632>`_
Expand All @@ -1212,7 +1216,7 @@ Plugin API
----------

Bugfixes
~~~~~~~
~~~~~~~~

- Allow plugins to unset the ``queryset_filtering_required_permission`` attribute in ``NamedModelViewSet``.
`#8444 <https://pulp.plan.io/issues/8444>`_
Expand Down Expand Up @@ -1635,6 +1639,7 @@ Deprecations
access_policy = AccessPolicy.get(viewset_name="MyViewSet")
access_policy.viewset_name = "objectclass/myplugin/myclass"
access_policy.save()

`#7845 <https://pulp.plan.io/issues/7845>`_
- The ``pulpcore.plugin.models.UnsupportedDigestValidationError`` is being deprecated and
will be removed in 3.10.
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ CONTENT_APP_TTL
.. _pulp-cache:

CACHE_ENABLED
^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^

.. note:: This feature is provided as a tech-preview

Expand All @@ -199,7 +199,7 @@ CACHE_ENABLED
responses to be stored inside the cache.

CACHE_SETTINGS
^^^^^^^^^^^^^
^^^^^^^^^^^^^^

Dictionary with tunable settings for the cache:

Expand Down
1 change: 0 additions & 1 deletion docs/contributing/platform-api/app/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ pulp.app

apps
auth
fields
models
response
serializers
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/platform-api/tasking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ pulp.tasking.constants
.. automodule:: pulpcore.tasking.constants

pulp.tasking.pulpcore_worker
-------------------
----------------------------

.. automodule:: pulpcore.tasking.pulpcore_worker

Expand Down
1 change: 0 additions & 1 deletion docs/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Installation Options
hardware-requirements
instructions
storage
authentication

Other links
:ref:`DevSetup`

0 comments on commit fe3a78a

Please sign in to comment.