Skip to content
This repository has been archived by the owner on Jun 8, 2022. It is now read-only.

Commit

Permalink
imrovement
Browse files Browse the repository at this point in the history
  • Loading branch information
ShivangKakkar committed Jan 16, 2022
1 parent 393603e commit e117b02
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
6 changes: 4 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
author = 'StarkProgrammer'
release = '2022'
extensions = [
# "myst_parser",
"sphinx_copybutton"
]
latex_engine = "xelatex"
# latex_engine = "xelatex"
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
html_theme = 'sphinx_rtd_theme'
html_theme_options = {"logo_only": True}
# html_theme_options = {"logo_only": True}
# html_logo = "WebsiteLogo.png"
html_favicon = 'favicon.ico'
html_static_path = ['_static']
copybutton_prompt_text = "$ "
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This documentation is designed primarily for absolute beginners keeping in mind


Documentation
^^^^^^^^^^^
^^^^^^^^^^^^^

.. hlist::
:columns: 1
Expand Down
13 changes: 8 additions & 5 deletions docs/introduction/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,18 @@ Steps

1. If you are using Windows, tap on Start button and search for **cmd**. If you are using MacOS or Linux, search for **Terminal**.


2. Install PyStark with pip:

.. code-block:: console
pip3 install pystark
$ pip3 install pystark
3. Generate a boilerplate using PyStark's command-line tool.

.. code-block:: console
pystark --boilerplate
$ pystark --boilerplate
4. Open the file manager in current directory. For Windows use ``start .`` ; for MacOS use ``open .`` and for Linux use ``xdg-open .`` . The dot (.) after command is required for opening in current directory.

Expand All @@ -33,14 +35,15 @@ Steps

.. code-block:: console
python3 bot.py
$ python3 bot.py
What does this do?
##################

The above steps will help you set up your bot and run it. You can use the command **/start** to check if your bot is actually running.
Your bot now has four default commands.

Your bot now has four default commands:

.. hlist::
:columns: 1
Expand All @@ -51,4 +54,4 @@ Your bot now has four default commands.
- ``/id`` - Get Telegram ID (also works in groups)


You can change the message for all commands in ``data.py`` file.
You can change the messages for all commands in ``data.py`` file.

0 comments on commit e117b02

Please sign in to comment.