Skip to content

Commit

Permalink
docs: Add new files and update index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jjjermiah committed Feb 4, 2024
1 parent 5d94bba commit 861cb37
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@
:hidden:
markdowns/NBIA.md
test.rst
markdowns/Installation.md
Tutorial.ipynb
markdowns/CHANGELOG.md
markdowns/CONTRIBUTING.md
markdowns/CONDUCT.md
Tutorial.ipynb
autoapi/index
```
39 changes: 39 additions & 0 deletions docs/test.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
.. Your Project Documentation
===========================
Introduction
------------

Your introduction goes here.

Usage
-----

.. tabs::

.. tab:: Command Line

To perform an operation using the command line, use the following command:

.. code-block:: bash
your_command_line_tool --option1 value1 --option2 value2
.. tab:: Python

To perform the same operation using the Python package, follow these steps:

.. code-block:: python
from your_python_package import YourClass
instance = YourClass(option1='value1', option2='value2')
instance.run_operation()
Configuration
-------------

Your configuration details go here.

...

0 comments on commit 861cb37

Please sign in to comment.