From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 9004 invoked by alias); 20 Feb 2015 09:17:24 -0000 Mailing-List: contact gcc-patches-help@gcc.gnu.org; run by ezmlm Precedence: bulk List-Id: List-Archive: List-Post: List-Help: Sender: gcc-patches-owner@gcc.gnu.org Received: (qmail 8994 invoked by uid 89); 20 Feb 2015 09:17:23 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=ham version=3.3.2 X-HELO: rock.gnat.com Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-SHA encrypted) ESMTPS; Fri, 20 Feb 2015 09:17:23 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id 0210D116325 for ; Fri, 20 Feb 2015 04:17:21 -0500 (EST) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id AG9SwYzREDat for ; Fri, 20 Feb 2015 04:17:20 -0500 (EST) Received: from kwai.gnat.com (kwai.gnat.com [IPv6:2620:20:4000:0:7a2b:cbff:fe60:cb11]) by rock.gnat.com (Postfix) with ESMTP id E5CA811630C for ; Fri, 20 Feb 2015 04:17:20 -0500 (EST) Received: by kwai.gnat.com (Postfix, from userid 4192) id DA9643FE3B; Fri, 20 Feb 2015 04:17:20 -0500 (EST) Date: Fri, 20 Feb 2015 09:26:00 -0000 From: Arnaud Charlet To: gcc-patches@gcc.gnu.org Subject: [Ada] convert GNAT doc to sphinx Message-ID: <20150220091720.GA16093@adacore.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.5.21 (2010-09-15) X-SW-Source: 2015-02/txt/msg01246.txt.bz2 As discussed last year, we've converted the GNAT main documentation (gnat_rm.texi and gnat_ugn.texi) to reST/sphinx, so the master doc can now be found under gcc/ada/doc. We're keeping automatically generated .texi files for now under gcc/ada so that people only having texinfo tools can still generate the documentation in various formats. Once GCC has more generally switched to reST/sphinx, we can finalize the transition and make the .rst files first class citizens/built by default. Currently you need to manually call the Makefile in the doc subdirectory to generate documentation using sphinx, e.g: make -C doc will yield a help on the various available build targets: << Please use `make ' where is one of DOC_NAME.html to make standalone HTML files DOC_NAME.pdf to make LaTeX files and run them through pdflatex DOC_NAME.txt to make text files DOC_NAME.texinfo to make Texinfo files DOC_NAME.info to make info files DOC_NAME.all to build DOC_NAME for all previous formats all to build all documentations in all formats html-all same as previous rule but only for HTML format pdf-all same as previous rule but only for PDF format txt-all same as previous rule but only for text format texinfo-all same as previous rule but only for texinfo format info-all same as previous rule but only for info format DOC_NAME should be a documentation name in the following list: gnat_rm gnat_ugn source and location can be overriden using SOURCEDIR and BUILDDIR variables >> For example: $ make -C doc all $ make -C doc gnat_ugn.pdf The SOURCEDIR and BUILDDIR variables have been introduced in doc/Makefile in order to ease further integration with the GCC Makefiles. Not including the diff which is very large and not very interesting. Tested on x86_64-pc-linux-gnu, committed on trunk. 2015-02-20 Arnaud Charlet * gnat_rm.texi, gnat_ugn.texi: Now automatically generated from sphinx in the doc directory. * doc: New directory containing sphinx versions of gnat_rm and gnat_ugn