diff --git a/docs/source/getting_started/Installation.md b/docs/source/getting_started/Installation.md index 8adfc4cf3ce7f76f968678d811032a8146332900..866738b6c189d46f94c78d5fb3717aed28f82914 100644 --- a/docs/source/getting_started/Installation.md +++ b/docs/source/getting_started/Installation.md @@ -10,6 +10,8 @@ BiTIA CLI is available on [PyPi] as [BiTIA]. Installing bitia is very simple. You only need to have [python-pip] installed in your system. +*** + To Install **BiTIA** using pip, run this command: diff --git a/docs/source/getting_started/Working.md b/docs/source/getting_started/Working.md index 860ac36e4889e159c9303af901b2f4d5d8582ddf..750fbd332d5e785ca125f7000cc8fc44bf7b3b36 100644 --- a/docs/source/getting_started/Working.md +++ b/docs/source/getting_started/Working.md @@ -30,6 +30,17 @@ To list available commands and options in bitia, execute `bitia --help` </div> +```{toctree} +:hidden: + +commands/bitia_checksum +commands/bitia_logs +commands/bitia_create_container +commands/bitia_list_container +commands/bitia_run +commands/bitia_submit +``` + ## Commands <div style="float:left"> diff --git a/docs/source/getting_started/commands/bitia_checksum.md b/docs/source/getting_started/commands/bitia_checksum.md index 64aebbe17c08218233617173f798df720f44bb7f..54e6786f7a98279d285482af0459f52085801293 100644 --- a/docs/source/getting_started/commands/bitia_checksum.md +++ b/docs/source/getting_started/commands/bitia_checksum.md @@ -44,6 +44,6 @@ value that represents the number of bits in a transmission message </div> -<script type="text/javascript" src="../../_static/js/termynal.js" data-termynal-container="#termynal|#termynal1"></script> +<script type="text/javascript" src="https://raw.githack.com/Ganz1285/terminal/main/termynal.js" data-termynal-container="#termynal|#termynal1"></script> diff --git a/docs/source/index.md b/docs/source/index.md index 554436bede4de1e797cced726b6e3197f8493db9..8c2a49fb3c57b8889ff8d20cd60a6af6ee159d35 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -30,14 +30,14 @@ BiTIA has two components: **bitia-cli** and **bitia-runner**. BiTIA CLI is on the client side and allows clients to submit tasks to the bitia server. BiTIA runner is on the server side and operates the given tasks to produce results. -## **bitia-cli** +## BiTIA CLI Most users only need the `bitia-cli` tool to submit tasks. BiTIA CLI creates a zip file of the user input(pipeline) containing a unique hash and ships it to the server. [see some examples]: examples ```{toctree} -:hidden: true +:hidden: getting_started/Installation getting_started/Working