Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add keyring troubleshooting #1289

Merged
merged 3 commits into from
Nov 22, 2024
Merged

docs: add keyring troubleshooting #1289

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7fabfba
docs: add keyring troubleshooting
dgarcia360 Nov 12, 2024
0ec6d06
Update docs/source/commands.rst
dgarcia360 Nov 15, 2024
0f4e353
Actualizar commands.rst
dgarcia360 Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions docs/source/commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,37 @@ To decrease verbosity, use the option ``-Q``:

make preview SPHINXOPTS=-Q

To fix the error ``pyproject.toml changed significantly since poetry.lock was last generated.``, run the following command:

Troubleshooting
...............

Issue: pyproject.toml changed significantly since poetry.lock was last generated
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Solution:**

#. Run the following command:

.. code:: console

poetry lock --no-update

Then, run the preview command again.
#. Run the `make preview` command again.

Issue: Keyring asks for a password
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This issue is due to a known problem with Poetry that primarily affects GNOME users. For more details, see `poetry/poetry#3949 <https://github.com/python-poetry/poetry/issues/8761>`.
dgarcia360 marked this conversation as resolved.
Show resolved Hide resolved

**Solution:**

#. Edit `docs/Makefile` to add the `POETRY` variable as follows:

.. code::

POETRY = PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring poetry

#. Run the `make preview` command again.

multiversionpreview
===================
Expand Down
11 changes: 10 additions & 1 deletion docs/source/getting-started/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,16 @@ Step 3: Preview the site locally

#. Delete or adapt the sample documentation files under ``docs/source``.

#. From the command line, run ``make preview`` within the ``docs`` folder. Fix any warnings raised by Sphinx.
#. From the command line, run ``make preview`` within the ``docs`` folder:

.. code-block:: console

cd docs
make preview

.. tip:: For troubleshooting, refer to the :ref:`preview command <Make_Preview>` documentation.

#. Fix any warnings raised by Sphinx.

#. Once the docs build without errors, open ``http://127.0.0.1:5500/`` to preview the generated site.

Expand Down
9 changes: 8 additions & 1 deletion docs/source/getting-started/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,14 @@ This file contains scripts that you can run to create a testing environment, com

To preview the docs locally:

#. From the command line, run ``make preview`` within the ``docs`` folder.
#. From the command line, run ``make preview`` within the ``docs`` folder:

.. code-block:: console

cd docs
make preview

.. tip:: For troubleshooting, refer to the :ref:`preview command <Make_Preview>` documentation.

#. Open ``http://127.0.0.1:5500/`` to preview the generated site with you changes.

Expand Down