From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gcc-refused-email@gnu.org>
Received: from fencepost.gnu.org (fencepost.gnu.org [IPv6:2001:470:142:3::e])
 by sourceware.org (Postfix) with ESMTPS id B3EFE388F017;
 Mon, 12 Jul 2021 17:12:57 +0000 (GMT)
DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org B3EFE388F017
Received: from 84.94.185.95.cable.012.net.il ([84.94.185.95]:4460
 helo=home-c4e4a596f7)
 by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
 (Exim 4.90_1) (envelope-from <eliz@gnu.org>)
 id 1m2zUA-0006ZA-Uq; Mon, 12 Jul 2021 13:12:55 -0400
Date: Mon, 12 Jul 2021 20:12:46 +0300
Message-Id: <83fswja229.fsf@gnu.org>
From: Eli Zaretskii <eliz@gnu.org>
To: Martin =?utf-8?Q?Li=C5=A1ka?= <mliska@suse.cz>
Cc: hp@bitrange.com, gcc@gcc.gnu.org, gcc-patches@gcc.gnu.org,
 joseph@codesourcery.com
In-Reply-To: <a963e734-4090-f293-58ba-942ddec47345@suse.cz> (message from
 Martin =?utf-8?Q?Li=C5=A1ka?= on Mon, 12 Jul 2021 16:37:00 +0200)
Subject: Re: Benefits of using Sphinx documentation format
References: <1446990946.2994.192.camel@surprise>
 <3a2a573b-5185-fff5-f9da-6e5e39953ad6@suse.cz>
 <alpine.DEB.2.22.394.2106021645550.693958@digraph.polyomino.org.uk>
 <8641dc55-5412-fbd7-bafd-13604311f5ad@suse.cz>
 <alpine.DEB.2.22.394.2106101645050.424830@digraph.polyomino.org.uk>
 <e92d2ce5-59a0-ff65-bbfc-27072a452bfa@suse.cz>
 <alpine.DEB.2.22.394.2106111544150.479659@digraph.polyomino.org.uk>
 <5ffe3e32-ece0-a1b4-1fcf-e35177fa80b5@suse.cz>
 <alpine.DEB.2.22.394.2106231551380.13671@digraph.polyomino.org.uk>
 <87489d9a-44e2-411c-3f3a-534d07e78b95@suse.cz>
 <0866a0ea-c846-ea5e-ac7a-d1c8f106cc45@suse.cz>
 <5bb9a10d-f3b9-f16a-7430-bbae2d4978e2@suse.cz>
 <alpine.DEB.2.22.394.2106281533020.220739@digraph.polyomino.org.uk>
 <2f60f602-5d88-7674-9620-2172748664c5@suse.cz> <83a6n8obh4.fsf@gnu.org>
 <57743e51-04d5-ec2e-b684-54f0321ef0bd@suse.cz> <83pmw3mrcg.fsf@gnu.org>
 <alpine.BSF.2.20.16.2107021942320.92378@arjuna.pair.com>
 <98388e12-3712-575b-9387-45b6ea7ef498@suse.cz> <83v95fabwx.fsf@gnu.org>
 <a963e734-4090-f293-58ba-942ddec47345@suse.cz>
MIME-version: 1.0
Content-type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
X-Spam-Status: No, score=2.2 required=5.0 tests=BAYES_00, KAM_DMARC_STATUS,
 RCVD_IN_BARRACUDACENTRAL, RCVD_IN_DNSWL_LOW, SPF_HELO_NONE, SPF_PASS,
 TXREP autolearn=no autolearn_force=no version=3.4.4
X-Spam-Level: **
X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on
 server2.sourceware.org
X-BeenThere: gcc-patches@gcc.gnu.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Gcc-patches mailing list <gcc-patches.gcc.gnu.org>
List-Unsubscribe: <https://gcc.gnu.org/mailman/options/gcc-patches>,
 <mailto:gcc-patches-request@gcc.gnu.org?subject=unsubscribe>
List-Archive: <https://gcc.gnu.org/pipermail/gcc-patches/>
List-Post: <mailto:gcc-patches@gcc.gnu.org>
List-Help: <mailto:gcc-patches-request@gcc.gnu.org?subject=help>
List-Subscribe: <https://gcc.gnu.org/mailman/listinfo/gcc-patches>,
 <mailto:gcc-patches-request@gcc.gnu.org?subject=subscribe>
X-List-Received-Date: Mon, 12 Jul 2021 17:12:58 -0000

> Cc: hp@bitrange.com, gcc@gcc.gnu.org, gcc-patches@gcc.gnu.org,
>  joseph@codesourcery.com
> From: Martin Liška <mliska@suse.cz>
> Date: Mon, 12 Jul 2021 16:37:00 +0200
> 
> >   4) The need to learn yet another markup language.
> >      While this is not a problem for simple text, it does require a
> >      serious study of RST and Sphinx to use the more advanced features.
> 
> No, majority of the documentation is pretty simple: basic formatting, links, tables and
> code examples.

We also have documentation of APIs (a.k.a. "functions").  I actually
tried to find in the Sphinx docs how to do that and got lost.  So, not
really "very simple".