Skip to content
Snippets Groups Projects
Commit fdec0ea4 authored by Selvaganapathy Kannan's avatar Selvaganapathy Kannan
Browse files

docs: add table of contents

parent b1cd595c
No related branches found
No related tags found
1 merge request!15Update Documentation
Pipeline #4623 passed with stages
in 4 minutes and 37 seconds
...@@ -10,6 +10,8 @@ BiTIA CLI is available on [PyPi] as [BiTIA]. ...@@ -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. Installing bitia is very simple. You only need to have [python-pip] installed in your system.
***
To Install **BiTIA** using pip, run this command: To Install **BiTIA** using pip, run this command:
......
...@@ -30,6 +30,17 @@ To list available commands and options in bitia, execute `bitia --help` ...@@ -30,6 +30,17 @@ To list available commands and options in bitia, execute `bitia --help`
</div> </div>
```{toctree}
:hidden:
commands/bitia_checksum
commands/bitia_logs
commands/bitia_create_container
commands/bitia_list_container
commands/bitia_run
commands/bitia_submit
```
## Commands ## Commands
<div style="float:left"> <div style="float:left">
......
...@@ -44,6 +44,6 @@ value that represents the number of bits in a transmission message ...@@ -44,6 +44,6 @@ value that represents the number of bits in a transmission message
</div> </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>
...@@ -30,14 +30,14 @@ BiTIA has two components: **bitia-cli** and **bitia-runner**. ...@@ -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 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 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. 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. 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 [see some examples]: examples
```{toctree} ```{toctree}
:hidden: true :hidden:
getting_started/Installation getting_started/Installation
getting_started/Working getting_started/Working
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment