From 0d3582a21a08963d4a97e22c0595f9562638841f Mon Sep 17 00:00:00 2001 From: juantocamidokura Date: Fri, 9 Dec 2022 13:22:08 +0100 Subject: [PATCH 1/2] Docs: Remove outdated and misleading Poetry guide --- docs/user/guides/poetry.rst | 67 ------------------------------------- 1 file changed, 67 deletions(-) delete mode 100644 docs/user/guides/poetry.rst diff --git a/docs/user/guides/poetry.rst b/docs/user/guides/poetry.rst deleted file mode 100644 index fcfc097131f..00000000000 --- a/docs/user/guides/poetry.rst +++ /dev/null @@ -1,67 +0,0 @@ -Specifying your dependencies with Poetry -======================================== - -Declaring your project metadata -------------------------------- - -Poetry is a :pep:`517`-compliant build backend, which means that -`it can generate your project -metadata `_ -using a standardized interface that can be consumed directly by pip. -To do that, first make sure that -the ``build-system`` section of your ``pyproject.toml`` -declares the build backend as follows: - -.. code-block:: toml - :caption: pyproject.toml - - [build-system] - requires = ["poetry_core>=1.0.0"] - build-backend = "poetry.core.masonry.api" - -Then, you will be able to install it on Read the Docs just using pip, -with a configuration like this: - -.. code-block:: yaml - :caption: .readthedocs.yaml - :emphasize-lines: 8-11 - - version: 2 - - build: - os: ubuntu-20.04 - tools: - python: "3.9" - - python: - install: - - method: pip - path: . - -For example, the `rich `_ Python library -`uses Poetry `_ -to declare its library dependencies -and installs itself on Read the Docs -`with pip `_. - -Locking your dependencies -------------------------- - -With your ``pyproject.toml`` file you are free to `specify the dependency -versions `_ -that are most appropriate for your project, -either by leaving them unpinned or setting some constraints. -However, to achieve :doc:`/guides/reproducible-builds` -it is better that you lock your dependencies, -so that the decision to upgrade any of them is yours. -Poetry does this using ``poetry.lock`` files -that contain the exact versions of all your transitive dependencies -(that is, all the dependencies of your dependencies). - -The first time you run ``poetry install`` in your project directory -`Poetry will generate a new poetry.lock -file `_ -with the versions available at that moment. -You can then `commit your poetry.lock to version -control `_ -so that Read the Docs also uses these exact dependencies. From 75a88030f13d080d9901a5a3e1b0c9bf42c2ffdb Mon Sep 17 00:00:00 2001 From: juantocamidokura Date: Mon, 12 Dec 2022 15:35:04 +0100 Subject: [PATCH 2/2] Docs: Removed toc poetry entry --- docs/user/guides/developers.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/user/guides/developers.rst b/docs/user/guides/developers.rst index d55762e70f6..05b91559ea6 100644 --- a/docs/user/guides/developers.rst +++ b/docs/user/guides/developers.rst @@ -14,7 +14,6 @@ or customize the documentation appearance. reproducible-builds embedding-content conda - poetry remove-edit-buttons build-using-too-many-resources edit-source-links-sphinx