Skip to content

Commit 9d61529

Browse files
committed
docs: update README to adjust paragon-build-tokens options and examples
1 parent 24aa859 commit 9d61529

File tree

1 file changed

+7
-31
lines changed

1 file changed

+7
-31
lines changed

plugins/tutor-contrib-paragon/README.rst

Lines changed: 7 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -102,45 +102,21 @@ Invoke the build process via Tutor:
102102
103103
tutor local do paragon-build-tokens [OPTIONS]
104104
105-
Available options:
106-
107-
- ``--source-tokens-only``
108-
Include only source design tokens in the build.
109-
110-
- ``--output-token-references/--no-output-token-references``
111-
Include references for tokens with aliases to other tokens in the build (default: enabled).
112-
113-
- ``--exclude-core``
114-
Exclude core from the token build.
115-
116-
- ``--themes <theme1,theme2>``
117-
Comma-separated list of theme names to compile. Defaults to the list defined in ``PARAGON_ENABLED_THEMES`` if not provided.
118-
119-
- ``-v, --verbose``
120-
Enable verbose logging.
105+
For more information about available options, refer to the `Paragon CLI documentation <https://github.com/openedx/paragon/?tab=readme-ov-file#paragon-cli>`__.
121106

122107
Examples
123108
--------
124109

125110
.. code-block:: bash
126111
127-
# Compile all themes listed in PARAGON_ENABLED_THEMES
128-
tutor local do paragon-build-tokens
129-
130-
# Compile only specific themes
131-
tutor local do paragon-build-tokens --themes theme-1,theme-2
132-
133-
# Compile with full debug logs
134-
tutor local do paragon-build-tokens --verbose
135-
136-
# Compile only source tokens for a single theme
137-
tutor local do paragon-build-tokens --themes theme-1 --source-tokens-only
112+
# Compile all themes listed in PARAGON_ENABLED_THEMES
113+
tutor local do paragon-build-tokens
138114
139-
# Compile without outputting token references
140-
tutor local do paragon-build-tokens --no-output-token-references
115+
# Compile only specific themes
116+
tutor local do paragon-build-tokens --themes theme-1,theme-2
141117
142-
# Compile excluding core tokens
143-
tutor local do paragon-build-tokens --exclude-core
118+
# Pass any other Paragon CLI options as needed
119+
tutor local do paragon-build-tokens --paragon-option value
144120
145121
Output
146122
------

0 commit comments

Comments
 (0)