From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by arlo.cworth.org (Postfix) with ESMTP id 7D81A6DE12C0 for ; Sun, 20 Aug 2017 12:30:45 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at cworth.org X-Spam-Flag: NO X-Spam-Score: 0.035 X-Spam-Level: X-Spam-Status: No, score=0.035 tagged_above=-999 required=5 tests=[AWL=0.055, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01] autolearn=disabled Received: from arlo.cworth.org ([127.0.0.1]) by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id HFe7HkGy3VgD for ; Sun, 20 Aug 2017 12:30:44 -0700 (PDT) Received: from mail-lf0-f50.google.com (mail-lf0-f50.google.com [209.85.215.50]) by arlo.cworth.org (Postfix) with ESMTPS id 06A5F6DE0C1B for ; Sun, 20 Aug 2017 12:30:44 -0700 (PDT) Received: by mail-lf0-f50.google.com with SMTP id k186so3555356lfe.2 for ; Sun, 20 Aug 2017 12:30:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nikula-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id; bh=DZoPVO+43aTTQyeEy3BQNUmn/hfinvp4TLLBZsuLxoI=; b=UpgpnTpbDVQy12hRJBQiOfgL3DGtIzCpPwC8LUiZJlyGhFoC4MTemitzvi9p4BppN8 0fA+WfaXzy9A4/tU+N9mqwr+lzSaDa7A7JM1VVVa11dT+wJ1C8+RKjfjT3SYLo0CJle3 dBEpQ1DZ6ZV9y+qBM/RUoixDN053n7q/qTDgJO7HelDyWEPBUX203RLmVFjtiIKOUVMW o7/2z+Y6X71raX6by/MDYBPGTHGBESTlGzFipr76Rh8JddUgcBv2n0H1r1KKlTzNbyGJ 58lw9DwX3M4OELsFoRkL3wF6wL1mWWLLs0CLwRSlyl/BGG/Y184oewJ9uP2eDh3e8KPU gWhw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=DZoPVO+43aTTQyeEy3BQNUmn/hfinvp4TLLBZsuLxoI=; b=DZhmrQMoG93cTIJBFm5o3rX/KLrIcQ9HDSiQhP4iQUuzMH/CUwsOeDSQZjUMHBvtNI LVlFyYjwzGJs5Qpi+duJ+e4opi+YVrK3h3MDKHv/E/qJyHsBUq2IkKvzzhUTQES4EGEy t0JLSs48JZZ9Z7VXwIDKmZEoUn4obU7PNSunBPvDlzsR88D/BKbt+UKjBUHYo8Ft+57O A+54Ukac06dTfoS98lkc74OHPGA2ADQQVrRua0pfwFYIjPbyvKcO6Wc/tiYGepRGwJq+ 68X2fOgNAM32IQefJz4YKZTn6s8govyBw1CGbhu21h2rtcuhs23mUsHRQc5xdQzC2AtZ 9cew== X-Gm-Message-State: AHYfb5j8EGv0g8EETGxlsXn57jmSiCmk3u5apUO5xJyOu+P/QYbMGxiE xteCjoMjQ9/yN8myFy4ZCA== X-Received: by 10.25.228.139 with SMTP id x11mr543561lfi.94.1503257441810; Sun, 20 Aug 2017 12:30:41 -0700 (PDT) Received: from localhost (mobile-access-5d6aa6-119.dhcp.inet.fi. [93.106.166.119]) by smtp.gmail.com with ESMTPSA id i138sm1592098lfe.20.2017.08.20.12.30.40 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Sun, 20 Aug 2017 12:30:40 -0700 (PDT) From: Jani Nikula To: notmuch@notmuchmail.org Subject: [RFC PATCH 0/4] doc: use Hawkmoth for API documentation Date: Sun, 20 Aug 2017 22:30:35 +0300 Message-Id: X-Mailer: git-send-email 2.11.0 X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 20 Aug 2017 19:30:45 -0000 Hawkmoth [1] is a minimalistic Sphinx C Domain autodoc directive extension to incorporate formatted C source code comments into Sphinx based documentation, by yours truly. See commit message of patch 2 for details. This series is probably more a real world test case for Hawkmoth than a serious attempt at getting it merged to Notmuch. Nonetheless, I decided to post it as food for thought. With hopes that one day it'll be a serious and compelling alternative for Sphinx based C API documentation. 'make sphinx-html' is probably more interesting than 'make build-man'. BR, Jani. [1] https://github.com/jnikula/hawkmoth Jani Nikula (4): doc: add man section 3 handling doc: use hawkmoth for generating libnotmuch api documentation lib: fix the biggest hawkmoth offenders in notmuch.h lib: add reStructuredText bling for API documentation in notmuch.h doc/Makefile.local | 10 ++-- doc/conf.py | 14 +++++ doc/index.rst | 1 + doc/man3/libnotmuch.rst | 20 +++++++ lib/notmuch.h | 139 ++++++++++++++++++++++++++---------------------- 5 files changed, 117 insertions(+), 67 deletions(-) create mode 100644 doc/man3/libnotmuch.rst -- 2.11.0