From c70b97d761ffba40e1c494bd9a78b9b278fbcb97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Tue, 28 Aug 2018 23:24:24 +0200 Subject: Use sphinx instead of pandoc, and add a deploy job --- doc/index.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 doc/index.rst (limited to 'doc/index.rst') diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000..5830747 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,16 @@ +.. biboumi documentation master file, created by + sphinx-quickstart on Mon Aug 27 19:50:26 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Biboumi – XMPP gateway to IRC +============================= + +.. include:: description.rst + +.. toctree:: + :maxdepth: 2 + + install + admin + user -- cgit v1.2.3 From 67ed7b59afc39c29e5cdb9954590c83dadb9d45f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Thu, 30 Aug 2018 16:52:47 +0200 Subject: Add the homepage URL in the doc, and reformat a few paragraphs --- doc/index.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'doc/index.rst') diff --git a/doc/index.rst b/doc/index.rst index 5830747..ca1bf0d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,7 +6,13 @@ Biboumi – XMPP gateway to IRC ============================= -.. include:: description.rst +Homepage: https://biboumi.louiz.org + +Forge: https://lab.louiz.org/louiz/biboumi + +Biboumi is an XMPP gateway that connects to IRC servers and translates +between the two protocols. It can be used to access IRC channels using any +XMPP client as if these channels were XMPP MUCs. .. toctree:: :maxdepth: 2 -- cgit v1.2.3 From e75b551a52f0f426b3bc098318d66ec9c75fc9a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Sat, 1 Sep 2018 23:12:39 +0200 Subject: Add the contributing.rst doc in the index --- doc/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/index.rst') diff --git a/doc/index.rst b/doc/index.rst index ca1bf0d..b97c8fd 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -20,3 +20,4 @@ XMPP client as if these channels were XMPP MUCs. install admin user + contributing -- cgit v1.2.3