-
Notifications
You must be signed in to change notification settings - Fork 30
docs: update CLI Usage page in the Sphinx documentation #269
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
docs: update CLI Usage page in the Sphinx documentation #269
Conversation
Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
|
I will rebase on staging to get the latest updates of the CLI options (from #270). |
Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
fc12961 to
35893b4
Compare
| Command Line Usage | ||
| ================== | ||
|
|
||
| You could use the bash script ``run_macaron.sh`` we provided to run Macaron as a Docker image (For more information on how to get this script, please see :ref:`Download Macaron <download-macaron>`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| You could use the bash script ``run_macaron.sh`` we provided to run Macaron as a Docker image (For more information on how to get this script, please see :ref:`Download Macaron <download-macaron>`). | |
| Use the bash script ``run_macaron.sh`` to run Macaron as a Docker container (for more information on how to get this script, please see :ref:`Download Macaron <download-macaron>`). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed in 602d683
docs/source/pages/using.rst
Outdated
| .. code-block:: shell | ||
| ./run_macaron.sh analyze -rp <repo_path> | ||
| ./run_macaron.sh macaron analyze -rp <repo_path> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file still contains ./run_macaron.sh macaron command. Please fix these.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed in 602d683
Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
…269) Signed-off-by: Trong Nhan Mai <trong.nhan.mai@oracle.com>
Closes #239 .