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.

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

fix documentation links #1208

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions packages/main/src/RPA/Browser/Selenium.py
Original file line number Diff line number Diff line change
Expand Up @@ -1956,7 +1956,7 @@ def open_user_browser(self, url: str, tab=True) -> None:
The keyword `Attach Chrome Browser` can be used to
access an already open browser with Selenium keywords.

Read more: https://robocorp.com/docs/development-guide/browser/how-to-attach-to-running-chrome-browser
Read more: https://robocorp.com/portal/tutorial/how-to-attach-to-running-chrome-browser

``url`` URL to open
``tab`` defines is url is opened in a tab (defaults to ``True``) or
Expand Down Expand Up @@ -2043,9 +2043,9 @@ def set_download_directory(
if download_pdf:
# Disable the viewer when downloading is preferred instead of viewing.
firefox_prefs["browser.download.viewableInternally.enabledTypes"] = ""
firefox_prefs[
"browser.helperApps.neverAsk.saveToDisk"
] += " application/pdf"
firefox_prefs["browser.helperApps.neverAsk.saveToDisk"] += (
" application/pdf"
)
self.download_preferences = {
"firefox": firefox_prefs,
}
Expand Down
2 changes: 1 addition & 1 deletion packages/main/src/RPA/Desktop/Windows.py
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ def __init__(self, backend: str = "uia") -> None:
deprecation(
"`RPA.Desktop.Windows` got deprecated and will be no longer maintained, "
"please use `RPA.Windows` instead "
"(https://robocorp.com/docs/libraries/rpa-framework/rpa-windows)"
"(https://robocorp.com/docs-robot-framework/libraries/rpa-framework/rpa-windows)"
)

OperatingSystem.__init__(self)
Expand Down
4 changes: 2 additions & 2 deletions packages/main/src/RPA/Desktop/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ class Desktop(DynamicCore):

Read more on identifying elements and crafting locators:

- `Desktop automation and RPA <https://robocorp.com/docs/development-guide/desktop>`_
- `How to find user interface elements using locators and keyboard shortcuts in Windows applications <https://robocorp.com/docs/development-guide/desktop/how-to-find-user-interface-elements-using-locators-and-keyboard-shortcuts-in-windows-applications>`_
- `Desktop automation and RPA <https://robocorp.com/docs-robot-framework/development-guide/desktop>`_
- `How to find user interface elements using locators and keyboard shortcuts in Windows applications <https://robocorp.com/docs-robot-framework/development-guide/desktop/how-to-find-user-interface-elements-using-locators-and-keyboard-shortcuts-in-windows-applications>`_

.. _VSCode: https://robocorp.com/docs/developer-tools/visual-studio-code/overview

Expand Down
2 changes: 1 addition & 1 deletion packages/main/src/RPA/Email/ImapSmtp.py
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ class ImapSmtp(OAuthMixin):
to given criteria.

Syntax needs to according to specification and more information about that
can be read from https://robocorp.com/docs/development-guide/email/sending-emails-with-gmail-smtp#listing-email-messages-by-criteria
can be read from https://robocorp.com/docs-robot-framework/development-guide/email/sending-emails-with-gmail-smtp#listing-email-messages-by-criteria

**Troubleshooting**

Expand Down
4 changes: 2 additions & 2 deletions packages/main/src/RPA/JavaAccessBridge.py
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,8 @@ class JavaAccessBridge:
.. _Accessibility Insights for Windows: https://accessibilityinsights.io/en/downloads/
.. _Access Bridge Explorer: https://github.com/google/access-bridge-explorer
.. _using Accessibility Insights: https://accessibilityinsights.io/docs/en/windows/reference/faq/#can-i-use-accessibility-insights-for-windows-on-a-windows-app-written-with-java
.. _RPA.Windows: https://robocorp.com/docs/libraries/rpa-framework/rpa-windows
.. _Java locators: https://robocorp.com/docs/development-guide/locators#java-locators
.. _RPA.Windows: https://robocorp.com/docs-robot-framework/libraries/rpa-framework/rpa-windows
.. _Java locators: https://robocorp.com/docs-robot-framework/development-guide/locators#java-locators

**Examples**

Expand Down
8 changes: 4 additions & 4 deletions packages/main/src/RPA/Robocorp/Vault.py
Original file line number Diff line number Diff line change
Expand Up @@ -211,13 +211,13 @@ def _raise_invalid_configuration():
" file.\n\n"
"Consult the 'Configure file vault support' section in the documentation"
" for step-by-step setup instructions:\n"
"https://robocorp.com/docs/development-guide/"
"https://robocorp.com/docs-robot-framework/development-guide/"
"variables-and-secrets/vault\n\n"
"When running from the Control Room, these variables should be "
"configured automatically.\n"
"If running with Robocorp Visual Studio Code extension, ensure that"
" the project is linked to Control Room:\n"
"https://robocorp.com/docs/developer-tools/visual-studio-code/"
"https://robocorp.com/docs-robot-framework/developer-tools/visual-studio-code/"
"extension-features#linking-to-control-room"
)

Expand Down Expand Up @@ -487,8 +487,8 @@ class Vault:
- ``RC_API_SECRET_TOKEN``: API Token for Robocorp Vault API
- ``RC_WORKSPACE_ID``: Control Room Workspace ID

.. _Robocorp Control Room Vault: https://robocorp.com/docs/development-guide/variables-and-secrets/vault
.. _Robocorp Code Extension: https://robocorp.com/docs/developer-tools/visual-studio-code/extension-features#connecting-to-control-room-vault
.. _Robocorp Control Room Vault: https://robocorp.com/docs-robot-framework/development-guide/variables-and-secrets/vault
.. _Robocorp Code Extension: https://sema4.ai/docs/automation/visual-studio-code/extension-features#connecting-to-control-room-vault
.. _rcc: https://robocorp.com/docs/rcc/workflow

File-based secrets can be set by defining two environment variables.
Expand Down
16 changes: 8 additions & 8 deletions packages/main/src/RPA/Robocorp/WorkItems.py
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ def input_path(self) -> Optional[Path]:
deprecation(
"Work items load - Old path style usage detected, please use the "
"'RPA_INPUT_WORKITEM_PATH' env var instead "
"(more details under documentation: https://robocorp.com/docs/development-guide/control-room/data-pipeline#developing-with-work-items-locally)" # noqa: E501
"(more details under documentation: https://robocorp.com/docs-robot-framework/development-guide/control-room/work-items#developing-with-work-items-locally)" # noqa: E501
)
path = os.getenv("RPA_INPUT_WORKITEM_PATH", default=old_path)
if path:
Expand All @@ -448,7 +448,7 @@ def output_path(self) -> Path:
deprecation(
"Work items save - Old path style usage detected, please use the "
"'RPA_OUTPUT_WORKITEM_PATH' env var instead "
"(more details under documentation: https://robocorp.com/docs/development-guide/control-room/data-pipeline#developing-with-work-items-locally)" # noqa: E501
"(more details under documentation: https://robocorp.com/docs-robot-framework/development-guide/control-room/work-items#developing-with-work-items-locally)" # noqa: E501
)
if not self.input_path:
raise RuntimeError(
Expand Down Expand Up @@ -770,7 +770,7 @@ class WorkItems:
the ``parsedEmail[Body]``.

E-mail attachments will be added into the work item as files. Read more on:
https://robocorp.com/docs/control-room/attended-or-unattended/email-trigger
https://robocorp.com/docs-robot-framework/control-room/unattended/email-trigger

Example:

Expand Down Expand Up @@ -868,9 +868,9 @@ class WorkItems:
`Developing with work items locally`_ section of the
`Using work items`_ development guide.

.. _Robocorp Code extension: https://robocorp.com/docs/setup/development-environment#visual-studio-code-with-robocorp-extensions
.. _Developing with work items locally: https://robocorp.com/docs/development-guide/control-room/work-items#developing-with-work-items-locally
.. _Using work items: https://robocorp.com/docs/development-guide/control-room/work-items
.. _Robocorp Code extension: https://robocorp.com/docs-robot-framework/developer-tools/visual-studio-code/extension-features
.. _Developing with work items locally: https://robocorp.com/docs-robot-framework/development-guide/control-room/work-items#developing-with-work-items-locally
.. _Using work items: https://robocorp.com/docs-robot-framework/development-guide/control-room/work-items

**Examples**

Expand Down Expand Up @@ -1044,8 +1044,8 @@ def _get_email_content(
deprecation(
"Legacy non-parsed e-mail trigger detected! Please enable "
'"Parse email" configuration option in Control Room. (more'
" details: https://robocorp.com/docs/control-room/attended"
"-or-unattended/email-trigger#parse-email)"
" details: https://robocorp.com/docs-robot-framework/control-room/"
"unattended/email-trigger#parse-email)"
)
output_keys = to_tuple(output_keys)
return content, parsed, output_keys
Expand Down
1 change: 0 additions & 1 deletion packages/main/src/RPA/application.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,6 @@ class BaseApplication(metaclass=MetaApplication):
Check the documentation below for more info:

- https://robocorp.com/docs/control-room/unattended/worker-setups/windows-desktop
- https://robocorp.com/docs/faq/windows-server-2016
"""

ROBOT_LIBRARY_SCOPE = "GLOBAL"
Expand Down
8 changes: 4 additions & 4 deletions packages/windows/src/RPA/Windows/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ class Windows(WindowsElementsMixin, DynamicCore):
channels:
- conda-forge
dependencies:
- python=3.9.13
- pip=22.1.2
- python=3.12.8
- pip=24.3.1
- pip:
- rpaframework-windows==7.0.2 # standalone Windows library (`rpaframework` includes this library)
- rpaframework-windows==8.0.0 # standalone Windows library (`rpaframework` includes this library)


**About terminology**
Expand Down Expand Up @@ -391,7 +391,7 @@ class ClassName
A more programmatic approach is to run ``Print Tree log_as_warnings=${True}``
keyword and then observe in the logs the found elements structure starting from
Desktop (or the currently set anchor / active window) as root. (refer to keyword's
`documentation <https://robocorp.com/docs/libraries/rpa-framework/rpa-windows/keywords#print-tree>`_
`documentation <https://robocorp.com/docs-robot-framework/libraries/rpa-framework/rpa-windows/keywords#print-tree>`_
for more details)

.. _Accessibility Insights: https://accessibilityinsights.io/
Expand Down
Loading