aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..ffc6afa
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,26 @@
+Welcome to thembed's documentation!
+===================================
+
+This module's role is to gather information about objects embedded in a
+link, like videos, pictures, etc. It is made by `Thomas Touhey`_ (``th``
+is for ``touhey``) for the `textoutpc`_ project, a BBCode to HTML
+translation module.
+
+To install the module, use pip:
+
+.. code-block:: bash
+
+ $ pip install thembed
+
+For more information and links, consult `the official website`_.
+
+Table of contents
+-----------------
+
+.. toctree::
+ :maxdepth: 2
+
+
+.. _Thomas Touhey: https://thomas.touhey.fr/
+.. _textoutpc: https://textout.touhey.pro/
+.. _the official website: https://thembed.touhey.pro/