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

doc: install_ncs: fix slash formatting #13481

Merged
merged 1 commit into from
Jan 2, 2024

Conversation

greg-fer
Copy link
Contributor

Updated formatting in parsed-literal and code-blocks. Changed \ to / for Windows commands.

@greg-fer greg-fer added the CI-disable Disable CI for this PR label Dec 20, 2023
@greg-fer greg-fer requested a review from peknis December 20, 2023 08:44
@github-actions github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Dec 20, 2023
@greg-fer greg-fer requested a review from rlubos December 20, 2023 08:44
@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Dec 20, 2023
@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

@@ -124,7 +124,7 @@ Depending on your preferred development environment, complete the following step
.. parsed-literal::
:class: highlight

nrfutil toolchain-manager config --set toolchain-index=*custom_toolchain_URL*
nrfutil toolchain-manager config --set toolchain-index=\*custom_toolchain_URL*
Copy link
Contributor

@peknis peknis Dec 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not do the trick yet. I believe this needs an empty space between the backslash and the asterisk.

@greg-fer greg-fer force-pushed the doc_installation_fix_formatting branch from f925428 to 7a34a08 Compare December 20, 2023 11:19
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Dec 20, 2023
@@ -124,7 +124,7 @@ Depending on your preferred development environment, complete the following step
.. parsed-literal::
:class: highlight

nrfutil toolchain-manager config --set toolchain-index=*custom_toolchain_URL*
nrfutil toolchain-manager config --set toolchain-index=\*custom_toolchain_URL\*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still missing an empty space after the backslash. The latter backslash is probably not needed.

@greg-fer greg-fer force-pushed the doc_installation_fix_formatting branch from 7a34a08 to d4112f5 Compare January 2, 2024 08:37
@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 2, 2024

#. Activate the virtual environment:

.. code-block:: bat

ncs\.venv\Scripts\activate.bat
ncs/.venv/Scripts/activate.bat
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not valid for command prompt

@NordicBuilder
Copy link
Contributor

Test specification

CI/Jenkins/NRF

  • Skipped

CI/Jenkins/integration

  • Skipped

Note: This message is automatically posted and updated by the CI

Updated formatting in parsed-literal and code-blocks.
Changed \ to / for some Windows program commands.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@greg-fer greg-fer force-pushed the doc_installation_fix_formatting branch from d4112f5 to 1a08d2d Compare January 2, 2024 11:10
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 2, 2024
@nordicjm nordicjm merged commit 835918c into nrfconnect:main Jan 2, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. CI-disable Disable CI for this PR doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants