plone.api 2.2.5__tar.gz → 2.4.0__tar.gz

plone_api-2.2.5/CHANGES.rst → plone_api-2.4.0/CHANGES.md

@@ -1,27 +1,63 @@
-Changelog
-=========
+# Changelog
 
-.. You should *NOT* be adding new change log entries to this file.
+<!--
+   You should *NOT* be adding new change log entries to this file.
    You should create a file in the news directory instead.
    For helpful instructions, please see:
    https://github.com/plone/plone.releaser/blob/master/ADD-A-NEWS-ITEM.rst
+-->
 
-.. towncrier release notes start
+<!-- towncrier release notes start -->
 
-2.2.5 (2025-01-24)
-------------------
+## 2.4.0 (2025-03-14)
 
-Bug fixes:
 
+### New features:
+
+- Add the `api.content.iter_ancestors` function for iterating over an object acquisition chain. @rohnsha0, @ale-rt #531
+
+
+### Bug fixes:
+
+- Replace `pkg_resources` with `importlib.metadata` @gforcada #4126
+
+
+### Internal:
+
+- Fix CI. @davisagli #571
+
+
+### Documentation:
+
+- Fix pull request preview builds on Read the Docs by replacing deprecated `pkg_resources` with `importlib.metadata`. @stevepiercy #565
+- Improve code style in the documentation snippets #568
+- Add `src` files in the check to determine whether to build a pull request preview on Read the Docs. @stevepiercy #574
+- Fix link in README to Contributing to `plone.api`. @stevepiercy #575
+
+## 2.3.0 (2025-02-21)
+
+New features:
+
+- Added the content API helper function `api.content.get_path`, which gets either the relative or absolute path of an object. @ujsquared (#532)
+- Added two new portal API functions:
+  - `api.portal.get_vocabulary`: Get a vocabulary by name
+  - `api.portal.get_vocabulary_names`: Get a list of all available vocabulary names
+  @ujsquared (#533)
+
+Internal:
+
+- Making it easier for new contributors to get started with a simple Makefile and a tidy 'contributing' chapter. @ksuess (#558)
+
+## 2.2.5 (2025-01-24)
+
+Bug fixes:
 
 - Fix api.content.get(path=path) when a item in the path is not accessible to the user.
   [pbauer] (#549)
 - Fix DeprecationWarnings. [maurits] (#4090)
 
-
 Documentation:
 
-
 - Preview docs on Read the Docs instead of Netlify. @stevepiercy (#545)
 - Remove Netlify stuff, follow up to #545. @stevepiercy
   - Sort and remove duplicate entries in `pyproject.toml`
@@ -30,269 +66,190 @@ Documentation:
   - Enable copy button for code blocks.
   - Add linkcheck to documentation of documentation. (#546)
 
-
-2.2.4 (2024-12-16)
-------------------
+## 2.2.4 (2024-12-16)
 
 Documentation:
 
-
 - Remove references to unused Coveralls. @stevepiercy (#543)
 
-
-2.2.3 (2024-10-23)
-------------------
+## 2.2.3 (2024-10-23)
 
 Documentation:
 
-
 - Fixed spelling of prerequisites. @stevepiercy (#541)
 
-
-2.2.2 (2024-07-30)
-------------------
+## 2.2.2 (2024-07-30)
 
 Documentation:
 
-
 - Overhaul contributing documentation for Plone 6. @stevepiercy (#539)
 - Use correct syntax for `no-index` in documentation. @stevepiercy (#540)
 
-
-2.2.1 (2024-06-26)
-------------------
+## 2.2.1 (2024-06-26)
 
 Bug fixes:
 
-
 - Removed `portal_properties` from documentation and tests.
   [maurits] (#125)
 
-
-2.2.0 (2024-05-06)
-------------------
+## 2.2.0 (2024-05-06)
 
 New features:
 
-
 - Report if a permission does not exist
   when calling `api.user.has_permission`.
   [gforcada] (#515)
 
-
 Bug fixes:
 
-
 - In relation.create: Fix edge case where existing RelationList value is None. @davisagli (#535)
 
-
 Internal:
 
-
 - Update configuration files.
   [plone devs] (cfffba8c)
 
-
-2.1.0 (2024-02-22)
-------------------
+## 2.1.0 (2024-02-22)
 
 New features:
 
-
 - Implemented unrestricted find of content types. @gogobd (#312)
 
-
 Internal:
 
-
 - Enhanced Makefile paths to address whitespace compatibility issues. @Vivek-04022001 (#530)
 
-
-2.0.9 (2024-02-12)
-------------------
+## 2.0.9 (2024-02-12)
 
 Internal:
 
-
 - Improved efficiency of view retrieval by deferring availability checks to error handling. @samriddhi99 (#479)
 
-
-2.0.8 (2023-12-14)
-------------------
+## 2.0.8 (2023-12-14)
 
 Bug fixes:
 
-
 - Fix `api.portal.translate` usage with country-specific language codes [@ericof] (#524)
 
-
-2.0.7 (2023-11-30)
-------------------
+## 2.0.7 (2023-11-30)
 
 Documentation:
 
+- Use the preferred `git switch -c` command. See <https://www.infoq.com/news/2019/08/git-2-23-switch-restore/>. @stevepiercy (#520)
 
-- Use the preferred `git switch -c` command. See https://www.infoq.com/news/2019/08/git-2-23-switch-restore/. @stevepiercy (#520)
-
-
-2.0.6 (2023-11-03)
-------------------
+## 2.0.6 (2023-11-03)
 
 Bug fixes:
 
-
 - More informative error message in plone.api.content.create() [ajung] (#516)
 
-
-2.0.5 (2023-10-25)
-------------------
+## 2.0.5 (2023-10-25)
 
 Bug fixes:
 
-
 - Replace deprecated assert methods.
   [gforcada] (#1)
 
-
 Internal:
 
-
 - Update GHA
   [gforcada] (#1)
 - Fixup tests because PloneSite gets IContentish again. @Akshat2Jain @jaroel (#518)
 
-
-2.0.4 (2023-07-14)
-------------------
+## 2.0.4 (2023-07-14)
 
 Bug fixes:
 
-
 - Do not run GitHub Actions tests twice.
   Only run GitHub Actions tests when committing directly against master or main or
   opening a pull request against master or main. This avoids to run the same test
   suite for the same environment twice.
   [thet] (#0)
+
 - Mockup TinyMCE settings: Remove unused AtD related views.
 
   Fix a test which was checking for "checkDocument" among other available views.
   "checkDocument" was a TinyMCE endpoint for unmaintained "After the Deadline"
   plugin, which is now removed. (#504)
 
-
 Documentation:
 
-
 - Enhance API docs of `portal.translate` to show that the domain is optional in some cases. @thet (#510)
 
-
-2.0.3 (2023-05-22)
-------------------
+## 2.0.3 (2023-05-22)
 
 Bug fixes:
 
-
 - Create relation only if there is no existing one with same source, target, relationname.
   But mark source as modified. @ksuess (#507)
 
-
-2.0.2 (2023-04-14)
-------------------
+## 2.0.2 (2023-04-14)
 
 Bug fixes:
 
-
 - Fix deletion of relations by relation name. @ksuess (#501)
 
-
 Documentation:
 
-
 - Update link for Training. @stevepiercy (#503)
 
-
-2.0.1 (2023-01-26)
-------------------
+## 2.0.1 (2023-01-26)
 
 Documentation:
 
-
 - Switch to 6.docs.plone.org (was 6.dev-docs.plone.org)
   [ksuess] (#497)
 - Fix links to appropriate versions of docs, in preparation for redirecting docs.plone.org to 6.docs.plone.org. Fix a few typos. Use renamed tox configuration option. [stevepiercy] (#498)
 - Pin Sphinx<5,>=3 due to sphinx-book-theme 0.3.3 requirement. [stevepiercy] (#499)
 - Update links to docs to use correct versions. [stevepiercy] (#500)
 
-
-2.0.0 (2022-11-26)
-------------------
+## 2.0.0 (2022-11-26)
 
 Bug fixes:
 
+- Require Python 3.8 or higher. [maurits] (#600)
 
-- Require Python 3.8 or higher.  [maurits] (#600)
-
-
-2.0.0b4 (2022-11-11)
---------------------
+## 2.0.0b4 (2022-11-11)
 
 Bug fixes:
 
-
 - Trigger a new deploy of core Plone documentation when plone.api documentation is updated.
   [esteele] (#496)
 
-
-2.0.0b3 (2022-10-03)
---------------------
+## 2.0.0b3 (2022-10-03)
 
 Bug fixes:
 
-
 - Use longer password in tests. [davisagli] (#495)
 
-
-2.0.0b2 (2022-09-07)
---------------------
+## 2.0.0b2 (2022-09-07)
 
 Bug fixes:
 
-
 - Ensure that the security related context managers
   restore the context even if an error occurs. (#374)
 
-
-2.0.0b1 (2022-06-23)
---------------------
+## 2.0.0b1 (2022-06-23)
 
 Bug fixes:
 
-
-- ``mutually_exclusive_parameters`` error message should include only related arguments.
+- `mutually_exclusive_parameters` error message should include only related arguments.
   [martin.peeters] (#489)
 
-
-2.0.0a4 (2022-06-07)
---------------------
+## 2.0.0a4 (2022-06-07)
 
 New features:
 
-
 - Documentation: Add meta data [ksuess, stevepiercy] (#485)
 
-
 Bug fixes:
 
-
 - plone.api.content.get should always return a content [ericof] (#487)
 
-
-2.0.0a3 (2022-05-26)
---------------------
+## 2.0.0a3 (2022-05-26)
 
 New features:
 
-
 - Do not require the request parameter to be specified. If not specify fallback to the global request [ale-rt] (#412)
 - Integration in new Plone 6 documentation. [ksuess] (#469)
 - Preview of documentation per pull request. Netlify bot adds link in PR comments. [ksuess] (#469)
@@ -301,58 +258,43 @@ New features:
   Update documentation [ksuess]
   Add some doctests to module plone.api.relation. [ksuess] (#474)
 
-
 Bug fixes:
 
-
 - Clean up docs from review of #469 [stevepiercy] (#476)
 - No unicode literals in documentation. [ksuess] (#483)
 
-
-2.0.0a2 (2021-10-13)
---------------------
+## 2.0.0a2 (2021-10-13)
 
 Bug fixes:
 
-
 - Fixed IndexError when calling set_registry_record with wrong value.
   [maurits] (#435)
-- Prevent startup error in relation code when ``plone.app.iterate`` is missing.
+- Prevent startup error in relation code when `plone.app.iterate` is missing.
   [maurits] (#462)
 
-
-2.0.0a1 (2021-09-01)
---------------------
+## 2.0.0a1 (2021-09-01)
 
 Breaking changes:
 
-
 - Drop support for Archetypes and Python 2.
   [pbauer] (#460)
 
-
 New features:
 
-
-- There is now a ``plone.api.relation`` module that make it easier to work with relations.
+- There is now a `plone.api.relation` module that make it easier to work with relations.
   [pbauer] (#449)
 
-
-1.11.0 (2021-06-30)
--------------------
+## 1.11.0 (2021-06-30)
 
 New features:
 
-
 - Drop support for Plone 4.3, 5.0, 5.1, add support for 6.0.
   The code might still work, but it is no longer tested.
   You can use releases in the 1.10 series on the older versions.
   [maurits] (#431)
 
-
 Bug fixes:
 
-
 - Add tests to verify that the intids utility is correct after moving content.
   [ale-rt, maurits] (#430)
 - Improve tox.ini so that plone.api could be tested locally.
@@ -363,180 +305,137 @@ Bug fixes:
   Fixes: #451
   [thet] (#452)
 
-
-1.10.4 (2020-09-28)
--------------------
+## 1.10.4 (2020-09-28)
 
 Bug fixes:
 
-
 - Fixed test failures on Python 3 with Products.MailHost 4.10.
   [maurits] (#3178)
 
-
-1.10.3 (2020-09-07)
--------------------
+## 1.10.3 (2020-09-07)
 
 Bug fixes:
 
-
-- Fixed deprecation warning for ``CMFPlone.interfaces.ILanguageSchema``.
+- Fixed deprecation warning for `CMFPlone.interfaces.ILanguageSchema`.
   [maurits] (#3130)
 
-
-1.10.2 (2020-04-20)
--------------------
+## 1.10.2 (2020-04-20)
 
 Bug fixes:
 
-
 - Minor packaging updates. (#1)
 
-
-1.10.1 (2020-03-04)
--------------------
+## 1.10.1 (2020-03-04)
 
 Bug fixes:
 
-
 - Remove deprecation warnings [ale-rt] (#432)
 - In tests, use stronger password.
   [maurits] (#436)
 - Removed duplicate and failing inline doctest for content.find.
   [maurits] (#437)
 
-
-1.10.0 (2019-05-01)
--------------------
+## 1.10.0 (2019-05-01)
 
 New features:
 
-
 - Gracefully handle missing registry records on an interface.
-   [gforcada] (#428)
+  : [gforcada] (#428)
 
-
-1.9.2 (2019-03-04)
-------------------
+## 1.9.2 (2019-03-04)
 
 Bug fixes:
 
-
-- Fix querying ``object_provides`` for multiple interfaces using 'and'
+- Fix querying `object_provides` for multiple interfaces using 'and'
   operator. [fRiSi] (#426)
 
-
-1.9.1 (2018-11-20)
-------------------
+## 1.9.1 (2018-11-20)
 
 Bug fixes:
 
 - Show only local roles when inherit=False.
   [tschorr]
 
-
-1.9.0 (2018-09-27)
-------------------
+## 1.9.0 (2018-09-27)
 
 New features:
 
 - Python 2/3 support.
   [pbauer]
 
-
-1.8.5 (2018-09-14)
-------------------
+## 1.8.5 (2018-09-14)
 
 Bug fixes:
 
 - Removed allow-hosts from base.cfg, so we can use the new pypi warehouse.
-  Refs https://github.com/plone/plone.api/issues/403
+  Refs <https://github.com/plone/plone.api/issues/403>
   [jaroel]
-
 - fix typos in doc strings
   [tkimnguyen]
-
 - Fix failing AT Collection creation when using api.content.create.
   [gbastien]
 
-
-1.8.4 (2018-04-24)
-------------------
+## 1.8.4 (2018-04-24)
 
 Bug fixes:
 
-- Call ``processForm`` with ``{None: None}`` dict as values.
-  This prevents ``processForm`` using ``REQUEST.form`` and overwriting
-  values already set by ``invokeFactory``.
-  Fixes `issue 99 <https://github.com/plone/plone.api/issues/99>`_.
+- Call `processForm` with `{None: None}` dict as values.
+  This prevents `processForm` using `REQUEST.form` and overwriting
+  values already set by `invokeFactory`.
+  Fixes [issue 99](https://github.com/plone/plone.api/issues/99).
   [david-batranu]
-
 - Simplification/minor speedup:
   Permissions checks now directly use AccessControl.
   Technical its now exact the same as before.
   Before a tool lookup was needed, calling a utility function, calling AccessControl.
   [jensens]
 
-
-
-1.8.3 (2018-02-23)
-------------------
+## 1.8.3 (2018-02-23)
 
 Bug fixes:
 
-- Improved code quality according to isort and flake8.  [maurits]
-
-- Fixed regular expression in test for Plone version.  [maurits]
+- Improved code quality according to isort and flake8. [maurits]
+- Fixed regular expression in test for Plone version. [maurits]
 
-
-1.8.2 (2018-01-17)
-------------------
+## 1.8.2 (2018-01-17)
 
 Bug fixes:
 
 - Fix test in Zope4,
-  where ``Products.PlonePAS.tools.memberdata.MemberData`` is an adapter now.
+  where `Products.PlonePAS.tools.memberdata.MemberData` is an adapter now.
   It can't be proofed to be equal when fetched twice.
   [jensens]
-
 - Change api.group.get_groups to work with CMF master.
   [jaroel]
-
 - Added six to deal with Python 2 / 3 compatibility.
   [rudaporto]
 
-1.8.1 (2017-10-17)
-------------------
+## 1.8.1 (2017-10-17)
 
 Bug fixes:
 
 - Don't rename an object when the id already is the target id.
-  Fixes `issue 361 <https://github.com/plone/plone.api/issues/361>`_.
+  Fixes [issue 361](https://github.com/plone/plone.api/issues/361).
   [jaroel]
-
 - Change content.delete to allow both obj=None and objects=[] or objects=None.
-  Fixes `issue 383 <https://github.com/plone/plone.api/issues/383>`_.
+  Fixes [issue 383](https://github.com/plone/plone.api/issues/383).
   [jaroel]
-
-- Let ``zope.i18n`` do the language negotiation for our ``translate`` function.
-  Our ``get_current_translation`` does not always give the correct one, especially with combined languages:
-  ``nl-be`` (Belgian/Flemish) should fall back to ``nl`` (Dutch).
+- Let `zope.i18n` do the language negotiation for our `translate` function.
+  Our `get_current_translation` does not always give the correct one, especially with combined languages:
+  `nl-be` (Belgian/Flemish) should fall back to `nl` (Dutch).
   The correct negotiated language can also differ per translation domain, which we do not account for.
-  ``zope.i18n`` does that better.
-  Fixes `issue 379 <https://github.com/plone/plone.api/issues/379>`_.
+  `zope.i18n` does that better.
+  Fixes [issue 379](https://github.com/plone/plone.api/issues/379).
   [maurits]
-
-- Fix use of Globals.DB which was removed in Zope4 (Fix https://github.com/plone/plone.api/issues/385)
+- Fix use of Globals.DB which was removed in Zope4 (Fix <https://github.com/plone/plone.api/issues/385>)
   [pbauer]
 
-1.8 (2017-08-05)
-----------------
+## 1.8 (2017-08-05)
 
 New features:
 
 - Add method to check if ZODB is in read-only mode.
   [loechel]
-
 - added tox.ini and code convention definitions in setup.py and .editorconfig so that they could be enforced
   [loechel]
 
@@ -545,9 +444,7 @@ Bug fixes:
 - Fixes Tests and code convention son this repository.
   [loechel]
 
-
-1.7 (2017-05-23)
-----------------
+## 1.7 (2017-05-23)
 
 New features:
 
@@ -556,39 +453,31 @@ New features:
 
 Bug fixes:
 
-- Simplify the ``plone.api.content.delete`` method.
+- Simplify the `plone.api.content.delete` method.
   [thet]
-
 - content.copy with safe_id=False should raise it's own exception. Fixes #340
   [jaroel]
 
-
-1.6.1 (2017-03-31)
-------------------
+## 1.6.1 (2017-03-31)
 
 Bug fixes:
 
 - Simplify delete and transition functions.
   [adamcheasley]
-
 - Do not reassign dynamic roles as local roles when using user.grant_roles().
   Fixes same issue as #351 for groups.
   [pbauer]
-
 - Include local roles granted from being in a group when using "inherit=False"
   in user.get_roles. Fixes #346
   [pbauer]
-
 - Ignore local roles granted on parents when using "inherit=False" in either
   user.get_roles or group.get_roles. Fixes #354
   [pbauer]
-
-- Fix title wrongly set by ``api.content.create`` when called from GS setup
-  handler https://github.com/plone/plone.api/issues/99
+- Fix title wrongly set by `api.content.create` when called from GS setup
+  handler <https://github.com/plone/plone.api/issues/99>
   [gotcha, pgrunewald]
 
-1.6 (2017-02-15)
-----------------
+## 1.6 (2017-02-15)
 
 New features:
 
@@ -599,31 +488,23 @@ Bug fixes:
 
 - Support user.get_roles for anonymous users. Refs #339
   [jaroel]
-
 - Fix imports from Globals that was removed in Zope4
   [pbauer]
-
 - Fix 'bad' quotes.
   [adamcheasley]
-
 - Typo in the documentation.
   [ale-rt]
-
 - Fix error in tests that try to add built-in roles, which no longer fails
   silently in Zope4.
   [MatthewWilkes]
-
 - Do not reassign global roles as local roles when using group.grant_roles()
   [pbauer]
-
 - reST syntax in documentation, follow style-guide, adjust setup.py
   [svx]
-
 - Do not reassign dynamic roles as local roles when using group.grant_roles().
   [pbauer]
 
-1.5.1 (2016-12-06)
-------------------
+## 1.5.1 (2016-12-06)
 
 New:
 
@@ -632,103 +513,80 @@ New:
 
 Fixes:
 
-- Fix translation related tests to use the ``plonelocales`` domain instead ``passwordresettool``.
+- Fix translation related tests to use the `plonelocales` domain instead `passwordresettool`.
   Products.PasswordResetTool was removed in Plone 5.1.
   [thet]
-
 - Allow plone.api.group.get_groups for Anonymous user. Refs #290
   [jaroel]
-
 - Allow adopting to a Special User. Fixes #320 - checking permissions for Anonymous User.
   [jaroel]
-
 - Fix an AttributeError in `api.user.revoke_roles`
   [ale-rt]
-
 - Remove print statements and use @security decorators to make
   code-analysis happy.
   [ale-rt]
-
 - Typo in the documentation.
   [ale-rt]
-
 - Fix travis and coveralls.
   [gforcada]
-
 - Various wording tweaks
   [tkimnguyen]
-
 - In api.content.move if source **and** target are specified and target is already
   source parent, skip the operation.
-
 - Fix test
   [gforcada]
-
 - Fix PRINTINGMAILHOST_ENABLED evaluation to respect Products.PrintingMailHost
   internal logic
   [ale-rt]
 
-1.5 (2016-02-20)
-----------------
+## 1.5 (2016-02-20)
 
 New:
 
 - Add `portal.translate`
   [ebrehault]
-
 - Add `portal.get_default_language` and `portal.get_current_language`
   [ebrehault]
 
 Fixes:
 
-- Fix ``test_zope_version`` test to be able to deal with development versions of Zope.
+- Fix `test_zope_version` test to be able to deal with development versions of Zope.
   [thet]
-
 - Remove the Plone APIs conventions. They are moved to
-  https://5.docs.plone.org/develop/styleguide
-  and https://5.docs.plone.org/develop/coredev/docs/git.html
+  <https://5.docs.plone.org/develop/styleguide>
+  and <https://5.docs.plone.org/develop/coredev/docs/git.html>
   [thet]
-
 - Cleanup code to match Plone's style guide.
   [gforcada]
-
 - Fix corner case on content.transition code: if a transition only has
-  exit transitions and no transition goes back to it ``find_path`` will fail.
+  exit transitions and no transition goes back to it `find_path` will fail.
   [gforcada]
-
 - Handle automatic transitions on api.content.transition.
   [gforcada]
 
-1.4.11 (2016-01-08)
--------------------
+## 1.4.11 (2016-01-08)
 
 New:
 
 - Allow to set/get registry settings from an interface.
-  https://github.com/plone/plone.api/issues/269
+  <https://github.com/plone/plone.api/issues/269>
   [gforcada]
 
-
-1.4.10 (2015-11-19)
--------------------
+## 1.4.10 (2015-11-19)
 
 Fixes:
 
 - Rerelease, as 1.4.9 misses the doctests directory.
   [maurits]
 
-
-1.4.9 (2015-11-19)
-------------------
+## 1.4.9 (2015-11-19)
 
 Fixes:
 
 - #283 portal.send_email does not respect transaction aborts
   [jensens]
 
-
-1.4.8 (2015-10-27)
-------------------
+## 1.4.8 (2015-10-27)
 
 New:
 
@@ -740,246 +598,179 @@ Fixes:
 - Fixed Plone 5 version comparison in tests.
   [maurits]
 
-
-1.4.7 (2015-09-27)
-------------------
+## 1.4.7 (2015-09-27)
 
 - Get email_charset value from the configuration registry, falling back
   to portal property if not found.
   [esteele]
 
+## 1.4.6 (2015-09-14)
 
-1.4.6 (2015-09-14)
-------------------
-
-- Fixed `api.content.find` with combination of depth and path.  Path
+- Fixed `api.content.find` with combination of depth and path. Path
   is no longer ignored then.
   [maurits]
-
 - Remove unittest2 dependency.
   [gforcada]
 
-
-1.4.5 (2015-09-09)
-------------------
+## 1.4.5 (2015-09-09)
 
 - Fixed long description of package to be valid restructured text,
   displaying nicely on PyPI.
   [maurits]
 
-
-1.4.4 (2015-09-08)
-------------------
+## 1.4.4 (2015-09-08)
 
 - Symlink doctests so that they'll be included in the built egg and don't
   break coredev builds.
   [esteele]
 
-
-1.4.3 (2015-09-08)
-------------------
+## 1.4.3 (2015-09-08)
 
 - Try to get use_email_as_login from registry first.
   [pbauer]
 
-
-1.4.2 (2015-09-07)
-------------------
+## 1.4.2 (2015-09-07)
 
 - Use the version defined in Products.CMFPlone in env.plone_version, just like Plone's control panel.
   Also fixes Jenkins testrunner where we don't have the Plone egg.
   [jaroel]
 
-
-1.4.1 (2015-09-07)
-------------------
+## 1.4.1 (2015-09-07)
 
 - Removed dependency on Products.CMFPlone to avoid circular dependencies. Products.CMFPlone will be there.
   [jaroel]
 
-
-1.4 (2015-09-04)
-----------------
+## 1.4 (2015-09-04)
 
 - plone.api.content.delete: add option check_linkintegrity. If True raise
   exception if deleting would result in broken links.
   [pbauer]
-
 - plone.api.content.find: object_provides arguments accepts tuples.
   Fixes #266.
   [ale-rt]
-
 - Fixed plone.api.content.create in Plone 5. Refs 160.
   [jaroel]
 - plone.api.content.transition: Now accepts kwargs that can be supplied to the workflow transition.
   [neilferreira]
 
-1.3.3 (2015-07-14)
-------------------
+## 1.3.3 (2015-07-14)
 
 - plone.api.content.get_state now allows for an optional default value.
   This is used when no workflow is defined for the object. Refs #246
   [jaroel]
-
 - plone.api.portal.get_registry_record now suggests look-alike records when no records is found. Refs #249.
   [jaroel]
-
 - Fixed tests for Plone 5. Refs #241.
   [jaroel]
-
 - Support Products.PrintingMailHost. Refs #228.
   [jaroel]
-
 - api.plone.org docs point to docs.plone.org/external/plone.api/docs/. Refs #202
   [jaroel]
-
 - plone.api.content.get_view no longer swallows exceptions.
   [jaroel]
-
 - Add plone.api.content.find. Refs #210
   [jaroel]
-
 - Make send_email compatible with Plone >= 5.0b2.
   [pbauer]
-
 - Use the source's parent as a target when no target is specified.
   [jaroel]
-
 - Make Products.Archetypes dependency optional. Fixes #197
   [jaroel]
-
 - Added local TOCS to main docs pages. Fixes #90.
   [jaroel]
-
 - Allow deleting multiple objects. Fixes #198
   [jaroel]
-
 - Fixed `make docs`.
   [jaroel]
-
 - Support Zope users in user.adopt_user. Fixes #171 and #157.
   [jaroel]
-
 - explicit dependencies in setup.py, explicit zcml loading in tests.
   [jensens]
-
 - import getToolByName from origin location
   [jensens]
-
 - overhaul of documentation: semantic linebreaks, few links fixed, minor
   rewording.
   [jensens]
-
-- fix ``revoke_roles`` method: now if is't called with obj parameter,
+- fix `revoke_roles` method: now if is't called with obj parameter,
   it doesn't set inherited roles locally.
   [cekk]
 
-1.3.2 (2014-11-17)
-------------------
+## 1.3.2 (2014-11-17)
 
-- fixes #190 - broken ``MANIFEST.in``.
+- fixes #190 - broken `MANIFEST.in`.
   [jensens]
 
+## 1.3.1 (2014-11-17)
 
-1.3.1 (2014-11-17)
-------------------
-
-- Resolves issues with ``README.rst`` symlink that prevented 1.3.0 from
+- Resolves issues with `README.rst` symlink that prevented 1.3.0 from
   being installed. And please never ever in future use symlinks in eggs, ok?
   [jensens]
 
-
-1.3.0 (2014-11-17)
-------------------
+## 1.3.0 (2014-11-17)
 
 - Fixes #184 NameChooser on rename used the wrong way and fails on
   safe_id=True.
   [benniboy]
-
 - Clarified documentation for content.copy, refs #185.
   [benniboy]
-
 - Fixes if a content is copied in the same folder or in a target folder, where
   same source id exists, the existing source(same folder) or third object
   (same id as source) gets renamed instead of the target.
   [benniboy]
-
 - Use getUserById to find the user when given a User object in adopt_user.
   [tschanzt]
-
-- Made ``api.portal.get_localized_time`` also work with datetime.date.
+- Made `api.portal.get_localized_time` also work with datetime.date.
   [nightmarebadger]
-
-- Raise better/expected errors in ``api.user.grant_roles`` and
-  ``api.user.revoke_roles``.
+- Raise better/expected errors in `api.user.grant_roles` and
+  `api.user.revoke_roles`.
   [adamcheasley]
-
-- Add ``api.user.has_permission`` ref #172.
+- Add `api.user.has_permission` ref #172.
   [adamcheasley]
 
-
-1.2.1 (2014-06-24)
-------------------
+## 1.2.1 (2014-06-24)
 
 - Resolve issues with CHANGES.rst symlink that prevented 1.2.0 from
   being installed in some circumstances.
   [mattss]
 
+## 1.2.0 (2014-06-24)
 
-1.2.0 (2014-06-24)
-------------------
-
-- Enhance ``api.content.transition`` with the ability to transition from the
+- Enhance `api.content.transition` with the ability to transition from the
   current state to a given state without knowing the transition 'path'
   refs. #162
   [adamcheasley]
-
-- Add ``api.env.plone_version()`` and ``api.env.zope_version()``, refs #126.
+- Add `api.env.plone_version()` and `api.env.zope_version()`, refs #126.
   [hvelarde]
-
-- Stop UnicodeDecodeErrors being swallowed in ``api.content.create``.
+- Stop UnicodeDecodeErrors being swallowed in `api.content.create`.
   [mattss]
-
-- Catch AttributeError in ``api.content.get`` (raised if only part of the
+- Catch AttributeError in `api.content.get` (raised if only part of the
   traversal path exists).
   [mattss]
 
-
-1.1.0 (2013-10-12)
-------------------
+## 1.1.0 (2013-10-12)
 
 - List supported Plone versions in setup.py.
   [zupo]
-
 - Plone 4.0 and 4.1 are now tested under Python 2.6 on CI.
   [hvelarde]
-
 - Use Plone 4.3 on development by default (was 4.2).
   [hvelarde]
 
-
-1.1.0-rc.1 (2013-10-10)
------------------------
+## 1.1.0-rc.1 (2013-10-10)
 
 - Fix README.rst so it renders correctly on PyPI.
   [zupo]
-
 - Use api.plone.org/foo redirects.
   [zupo]
-
 - Add MANIFEST.in file.
   [hvelarde]
 
-
-1.0.0-rc.3 (2013-10-09)
------------------------
+## 1.0.0-rc.3 (2013-10-09)
 
 - Packaging issues.
   [zupo]
 
-
-1.0.0-rc.2 (2013-10-09)
------------------------
+## 1.0.0-rc.2 (2013-10-09)
 
 - Proof-read the docs, improved grammar and wording.
   [cewing]
@@ -993,17 +784,18 @@ Fixes:
 - Amend user.get method to accept a userid parameter, refs #112.
   [cewing, xiru, winstonf88]
 
-  .. note::
-    This change fixes a bug in the earlier implementation that could cause
-    errors in some situations. This situation will only arise if the userid and
-    username for a user are not the same. If membrane is being used for content-
-    based user objects, or if email-as-login is enabled *and* a user has changed
-    their email address this will be the case. In the previous implementation
-    the username parameter was implicitly being treated as userid. The new
-    implementation does not do so. If consumer code is relying on this bug and
-    passing userid, and if that code uses the username parameter as a keyword
-    parameter, then lookup will fail. In all other cases, there should be no
-    difference.
+  :::{note}
+  This change fixes a bug in the earlier implementation that could cause
+  errors in some situations. This situation will only arise if the userid and
+  username for a user are not the same. If membrane is being used for content-
+  based user objects, or if email-as-login is enabled *and* a user has changed
+  their email address this will be the case. In the previous implementation
+  the username parameter was implicitly being treated as userid. The new
+  implementation does not do so. If consumer code is relying on this bug and
+  passing userid, and if that code uses the username parameter as a keyword
+  parameter, then lookup will fail. In all other cases, there should be no
+  difference.
+  :::
 
 - Add api.env.debug_mode() and api.env.test_mode(), refs #125.
   [sdelcourt]
@@ -1049,103 +841,72 @@ Fixes:
 - Fixed moving folderish objects.
   [pingviini]
 
-
-1.0.0-rc.1 (2013-01-27)
------------------------
+## 1.0.0-rc.1 (2013-01-27)
 
 - Increase test coverage.
   [cillianderoiste, JessN, reinhardt, zupo]
-
-- Implementation of ``api.env.adopt_roles()`` context manager for
+- Implementation of `api.env.adopt_roles()` context manager for
   temporarily switching roles inside a block.
   [RichyB]
-
-- Created ``api.env`` module for interacting with global environment.
+- Created `api.env` module for interacting with global environment.
   [RichyB]
-
 - Decorators for defining constraints on api methods. Depend on `decorator`
   package.
   [JessN]
-
 - Resolved #61: Improve api.portal.get().
   [cillianderoiste]
-
 - Use plone.api methods in plone.api codebase.
   [zupo]
-
-- Switch to `flake8` instead of `pep8`+`pyflakes`.
+- Switch to `flake8` instead of `` pep8`+`pyflakes ``.
   [zupo]
-
 - Get the portal path with absolute_url_path.
   [cillianderoiste]
-
 - Travis build speed-ups.
   [zupo]
-
 - Support for Python 2.6.
   [RichyB, zupo]
-
 - Support for Plone 4.0.
   [adamcheasley]
-
 - Support for Plone 4.3.
   [cillianderoiste, zupo]
-
 - Spelling fixes.
   [adamtheturtle]
-
 - Make get_view and get_tool tests not have hardcoded list of *all* expected
   values.
   [RichyB, cillianderoiste]
-
 - Code Style Guide.
   [iElectric, cillianderoiste, marciomazza, RichyB, thet, zupo]
-
-- Depend on ``manuel`` in setup.py.
+- Depend on `manuel` in setup.py.
   [zupo]
-
 - Documentation how to get/set member properties.
   [zupo]
-
-- Improvements to ``get_registry_record``.
+- Improvements to `get_registry_record`.
   [zupo]
 
-
-0.1b1 (2012-10-23)
-------------------
+## 0.1b1 (2012-10-23)
 
 - Contributors guide and style guide.
   [zupo]
-
 - Enforce PEP257 for docstrings.
   [zupo]
-
-- Fix ``get_navigation_root()`` to return object instead of path.
+- Fix `get_navigation_root()` to return object instead of path.
   [pbauer]
-
-- Implementation of ``get_permissions()``, ``get_roles()``,
-  ``grant_roles()`` and ``revoke roles()`` for users and groups.
+- Implementation of `get_permissions()`, `get_roles()`,
+  `grant_roles()` and `revoke roles()` for users and groups.
   [rudaporto, xiru]
-
-- Implementation of ``get_registry_record`` and ``set_registry_record``.
+- Implementation of `get_registry_record` and `set_registry_record`.
   [pbauer]
-
 - Use `Makefile` to build the project, run tests, generate documentation, etc.
   [witsch]
-
-- Moving all ReadTheDocs dependencies into ``rtd_requirements.txt``.
+- Moving all ReadTheDocs dependencies into `rtd_requirements.txt`.
   [zupo]
 
-
-0.1a2 (2012-09-03)
-------------------
+## 0.1a2 (2012-09-03)
 
 - Updated release, adding new features, test coverage, cleanup & refactor.
   [hvelarde, avelino, ericof, jpgimenez, xiru, macagua, zupo]
 
-
-0.1a1 (2012-07-13)
-------------------
+## 0.1a1 (2012-07-13)
 
 - Initial release.
   [davisagli, fulv, iElectric, jcerjak, jonstahl, kcleong, mauritsvanrees,