summaryrefslogtreecommitdiffstats
path: root/share/extensions/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/extensions/docs/index.rst')
-rw-r--r--share/extensions/docs/index.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/share/extensions/docs/index.rst b/share/extensions/docs/index.rst
new file mode 100644
index 0000000..abfc319
--- /dev/null
+++ b/share/extensions/docs/index.rst
@@ -0,0 +1,35 @@
+Welcome to inkex's documentation!
+=================================
+
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+
+ Tutorial <tutorial/index>
+ authors/index
+ Inkex Development <dev/index>
+ API Reference <source/index>
+
+**Useful links**:
+`Source Repository <https://gitlab.com/inkscape/extensions>`_ |
+`Issue Tracker <https://gitlab.com/inkscape/extensions/issues>`_ |
+`Chat <https://chat.inkscape.org/channel/inkscape_extensions>`_
+
+Inkex is:
+
+- a general-purpose SVG reading/writing/modification package
+- an object-oriented interface for access to
+ many common SVG attributes, such as paths and styles
+- the Python package that enables Inkscape extensions
+
+Furthermore, :mod:`inkex.gui` provides a way to ship GTK interfaces with extensions, and
+:mod:`inkex.tester` is a package to facilitate unit testing of extensions.
+
+Welcome to its documentation!
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`