diff --git a/requirements/docs.txt b/requirements/docs.txt index 03708d4..a180645 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -4,4 +4,7 @@ pydocstyle pygments restructuredtext_lint rstcheck -sphinx==1.7.* +sphinx==3.4.3 +docutils < 0.17 +sphinx_rtd_theme==0.5.1 +readthedocs-sphinx-search==0.1.0rc3 diff --git a/src/pyDataverse/docs/source/user/basic-usage.rst b/src/pyDataverse/docs/source/user/basic-usage.rst index 919acf0..6fd6a07 100644 --- a/src/pyDataverse/docs/source/user/basic-usage.rst +++ b/src/pyDataverse/docs/source/user/basic-usage.rst @@ -297,6 +297,8 @@ always leads to a major version change: >>> resp = api.publish_dataset(ds_pid, release_type="major") Dataset doi:10.5072/FK2/EO7BNB published +Note that the version release needs to be ``major`` if any files were added or modified. +A ``minor`` release will work for metadata changes, but it will return an error if there are changes in the dataset content. .. _user_basic-usage_download-data: