Skip to content

Commit 7cbca4a

Browse files
author
Pietro Albini
committed
General documentation cleanup
1 parent 99f24a0 commit 7cbca4a

25 files changed

+110
-93
lines changed

docs/api/bot.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. api-bot::
55

6-
~~~~~~~~~~~~~~~~~
6+
=================
77
Bots creation API
8-
~~~~~~~~~~~~~~~~~
8+
=================
99

1010
botogram is a microframework aimed to help you creating bots. It's obvious it
1111
has something to create them! Here is the reference of all the needed

docs/api/channels.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. _api-channels:
55

6-
~~~~~~~~~~~~
6+
============
77
Channels API
8-
~~~~~~~~~~~~
8+
============
99

1010
The Channels API provides a lightweight way to interact with channels. If you
1111
just want to send messages to a channel, it's better if you use this.

docs/api/components.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. _api-components:
55

6-
~~~~~~~~~~~~~~~~~~~~~~~
6+
=======================
77
Components creation API
8-
~~~~~~~~~~~~~~~~~~~~~~~
8+
=======================
99

1010
Creating components is one of the most useful features of botogram, since they
1111
allows you to reuse parts of your code in multiple bots. You can learn more

docs/api/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. _api:
55

6-
~~~~~~~~~~~~~
6+
=============
77
API reference
8-
~~~~~~~~~~~~~
8+
=============
99

1010
This section will cover the full reference of botogram's public API. The
1111
API will be kept backward compatible for at least the next release, even if

docs/api/telegram.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. _api-telegram:
55

6-
~~~~~~~~~~~~~~~~~~~~
6+
====================
77
Telegram API wrapper
8-
~~~~~~~~~~~~~~~~~~~~
8+
====================
99

1010
As an advantage to using botogram's :ref:`higher level API<api-bot>` and bot
1111
runner, many distracting and tedious details of working with
@@ -16,9 +16,6 @@ integrated into the classes presented here. These classes wrap Telegram's
1616
`API types`_ and detail the core objects your bot will deal with when going
1717
about its business.
1818

19-
Available Classes
20-
=================
21-
2219
* :py:class:`~botogram.User`
2320
* :py:class:`~botogram.Chat`
2421
* :py:class:`~botogram.Message`

docs/api/utility.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. api-utility::
55

6-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6+
================================
77
Utility functions and decorators
8-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8+
================================
99

1010
botogram ships with some functions and decorators aimed to simplify the bots
1111
development. Feel free to use them when you need them.

docs/changelog.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. _changelog:
55

6-
~~~~~~~~~~~~~~~~~~
6+
==================
77
botogram changelog
8-
~~~~~~~~~~~~~~~~~~
8+
==================
99

1010
Here you can see what changed in every botogram release.
1111

docs/channels.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. _channels:
55

6-
~~~~~~~~~~~~~~~~~~~~~
6+
=====================
77
Working with channels
8-
~~~~~~~~~~~~~~~~~~~~~
8+
=====================
99

1010
Telegram Channels provides a way to broadcast a message to multiple users. You
1111
can manually send messages to them with your preferred Telegram client, but
@@ -15,7 +15,6 @@ With botogram you can easily do that, without even the need to run the bot.
1515

1616
.. _channels-preparation:
1717

18-
===========
1918
Preparation
2019
===========
2120

@@ -33,7 +32,6 @@ channel. From it you should add your bot, and then you're ready.
3332

3433
.. _channels-standalone:
3534

36-
=========================
3735
Manage without a full bot
3836
=========================
3937

@@ -61,7 +59,6 @@ For example, if you want to send a text message you should do:
6159
6260
.. _channels-bot:
6361

64-
=========================
6562
Manage from a running bot
6663
=========================
6764

@@ -88,4 +85,5 @@ cites botogram in a chat, you can do this:
8885
user = message.from_.username
8986
9087
bot.send("@my_channel", "%s mentioned botogram!" % user)
91-
.. _@botfather: https://telegram.me/botfather
88+
89+
.. _@botfather: https://telegram.me/botfather

docs/custom-components.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
44
.. _custom-components:
55

6-
~~~~~~~~~~~~~~~~~~~~~~~~~~
6+
==========================
77
Creating custom components
8-
~~~~~~~~~~~~~~~~~~~~~~~~~~
8+
==========================
99

1010
Hopefully you'll get to a point when you've made a few bots. The problem is,
1111
there's a high chance parts of the code are duplicated between the bots. For
@@ -19,7 +19,6 @@ bot.
1919

2020
.. _custom-components-conduct:
2121

22-
==========================
2322
Components code of conduct
2423
==========================
2524

@@ -52,7 +51,6 @@ simplifying the end-user experience:
5251

5352
.. _custom-components-example:
5453

55-
====================
5654
An example component
5755
====================
5856

@@ -124,7 +122,6 @@ source code of the component is the following:
124122
125123
.. _custom-components-use:
126124

127-
========================
128125
Using a custom component
129126
========================
130127

docs/deploy/common.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
.. Copyright (c) 2015 Pietro Albini <[email protected]>
22
Released under the MIT license.
33
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4+
.. _deploy-common:
5+
6+
=============================
57
Common deployment information
6-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8+
=============================
79

810
Even if different deployment techniques are *really* different, all of them
911
have two essential things in common: server security and application
1012
configuration.
1113

14+
.. _deploy-common-security:
15+
1216
Server security considerations
1317
==============================
1418

@@ -37,6 +41,8 @@ others' things.
3741
communicate to ``api.telegram.org`` with HTTPS. You can block everything else
3842
your bot doesn't use.
3943

44+
.. _deploy-common-multiple:
45+
4046
Running multiple bots in the same process
4147
=========================================
4248

0 commit comments

Comments
 (0)