From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp-out2.suse.de (smtp-out2.suse.de [IPv6:2001:67c:2178:6::1d]) by sourceware.org (Postfix) with ESMTPS id 69FA23852752; Tue, 2 Aug 2022 12:48:29 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 69FA23852752 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=suse.cz Authentication-Results: sourceware.org; spf=fail smtp.mailfrom=suse.cz Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out2.suse.de (Postfix) with ESMTPS id 035DB1F8C9; Tue, 2 Aug 2022 12:48:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1659444508; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=By9m+XJ7X75wedQgHCov6q9DueDZkuBSZGlvo2jYMhQ=; b=F2+xPJ2m58uslZhkmEcLJHBqjlaAAlnKdKg+xW2yh0Zs5QNHg2eEIvLAR0m1o93dwKlMG4 sGv3yokhK5G9aLFd+rhQJBnXPJfyYr/NfI85/y6b85ZXyHnFtDGGhOUGKfWCFWx0/BorjO vaxy4lmYoyMDESc78V7AbSsLFbY+sCc= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1659444508; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=By9m+XJ7X75wedQgHCov6q9DueDZkuBSZGlvo2jYMhQ=; b=8WEI+aVSeVMxzRk8CvAPN6MN4sXbgMqGF5LryiudvhDHGshs67jIX9ZWVRNWL+aLnBNKKS CLpangqPGAx3ZsBw== Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id DA99A13A8E; Tue, 2 Aug 2022 12:48:27 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id kFC+Mxsd6WLvSAAAMHmgww (envelope-from ); Tue, 02 Aug 2022 12:48:27 +0000 Message-ID: <9ea57a95-fefe-81a3-848e-ede0893f5b61@suse.cz> Date: Tue, 2 Aug 2022 14:48:27 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.11.0 Subject: Re: Porting the Docs to Sphinx - project status Content-Language: en-US From: =?UTF-8?Q?Martin_Li=c5=a1ka?= To: GCC Patches , GCC Development Cc: Sandra Loosemore , "Joseph S. Myers" References: <9975b774-46d7-8870-fd92-498f5ec50ab4@suse.cz> In-Reply-To: <9975b774-46d7-8870-fd92-498f5ec50ab4@suse.cz> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-5.4 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, KAM_EU, KAM_SHORT, NICE_REPLY_A, SPF_HELO_NONE, SPF_SOFTFAIL, TXREP autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gcc@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 02 Aug 2022 12:48:31 -0000 On 1/31/22 15:06, Martin Liška wrote: > Hello. > > It's about 5 months since the last project status update: > https://gcc.gnu.org/pipermail/gcc-patches/2021-August/577108.html > Now it's pretty clear that it won't be merged before GCC 12.1 gets released. > > So where we are? I contacted documentation maintainers (Gerald, Sandra and Joseph) at the > end of the year in a private email, where I pinged the patches. My take away is that both > Gerald and Joseph are fine with the porting, while Sandra has some concerns. Based on her > feedback, I was able to improve the PDF generated output significantly and I'm pleased by the > provided feedback. That led to the following 2 Sphinx pulls requests that need to be merged > before we can migrate the documentation: [1], [2]. > > Since the last time I also made one more round of proofreading and the layout was improved > (mainly for PDF part). Current version of the documentation can be seen here: > https://splichal.eu/scripts/sphinx/ > > I would like to finish the transition once GCC 12.1 gets released in May/June this year. > There are still some minor regressions, but overall the Sphinx-based documentation should > be a significant improvement over what we've got right now. > > Please take this email as urgent call for a feedback! > > Thank you, > Martin > > [1] https://github.com/sphinx-doc/sphinx/pull/10087 > [2] https://github.com/sphinx-doc/sphinx/pull/10001 Hello. It's been another 5 months since the last project status update. In order to address some Sandra comments I had to work with upstream in order to merge a few pull requests. That has been achieved and Sphinx 5.1.0 can built the converted documentation. What has changed since the last time: 1) I made a couple of proof-reading rounds and the documentation should not contain any significant defects. 2) I used a more responsive HTML template Furo that works nicely on mobile devices as well. 3) Number of Sphinx warnings has been reduced. 4) configure script supports not --with-sphinx-build ([1]) that can be used when Sphinx is installed into pip env. 5) Building Documentation chapter was added to gccint manual ([2]). 6) I made a couple of screenshot that show up how is the docs better ([3], Chapter 1). I'm not planning sending a patchset as most of the patches would not fit in the email limit, so please fetch the following branch (the last 2 fixme commits will not be installed): $ git fetch origin refs/users/marxin/heads/sphinx-v7 $ git checkout FETCH_HEAD The generated documentation (built from GCC source based on the git branch) can be seen here: https://splichal.eu/gccsphinx-final/ I would like to merge the documentation during the summer if possible before a bigger changes will land in fall. Thank you, Martin [1] https://splichal.eu/gccsphinx-final/html/install/configuration.html#cmdoption-with-sphinx-build [2] https://splichal.eu/gccsphinx-final/html/gccint/source-tree-structure-and-build-system/the-gcc-subdirectory/building-documentation.html [3] https://splichal.eu/scripts/sphinx/demo/_build/latex/demo.pdf