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

First sketch for Remote docs #3962

Merged
merged 1 commit into from
Jan 27, 2025
Merged

First sketch for Remote docs #3962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion reference/extensions/authorization_plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The idea behind these plugins is to create custom integrations with each user's

Auth remote plugin
+++++++++++++++++++
This first plugin is a Python script that receives a ``remote`` object and an optional parameter: ``user``. If the user
This first plugin is a Python script that receives a :ref:`Remote <conan.api.model.Remote>` object and an optional parameter: ``user``. If the user
is provided, the expected output is the credentials that use that username. The output should be a tuple of the
username that we want to use for that remote, or ``None`` if no credentials are specified for that remote and we want
Conan to follow the normal login flow.
Expand Down
7 changes: 7 additions & 0 deletions reference/extensions/python_api/RemotesAPI.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ Remotes API

.. include:: ../../../common/experimental_warning.inc

.. _conan.api.model.Remote:

.. currentmodule:: conan.api.model

.. autoclass:: Remote
:members:

.. currentmodule:: conan.api.subapi.remotes

.. autoclass:: RemotesAPI
Expand Down