From: Arnaud Charlet <charlet@adacore.com>
To: gcc-patches@gcc.gnu.org
Subject: [Ada] convert GNAT doc to sphinx
Date: Fri, 20 Feb 2015 09:26:00 -0000 [thread overview]
Message-ID: <20150220091720.GA16093@adacore.com> (raw)
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 <target>' where <target> 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 <charlet@adacore.com>
* 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
next reply other threads:[~2015-02-20 9:17 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-02-20 9:26 Arnaud Charlet [this message]
2015-02-22 17:37 ` Tom de Vries
2015-02-22 18:30 ` Arnaud Charlet
2015-02-22 19:02 ` Tom de Vries
2015-02-22 19:35 ` Arnaud Charlet
2015-02-22 20:48 ` Tom de Vries
2015-02-23 2:28 ` Arnaud Charlet
2015-02-23 8:26 ` Tom de Vries
2015-02-25 12:02 ` Richard Biener
2015-02-25 11:05 ` Joseph Myers
2015-02-25 11:27 ` Arnaud Charlet
2015-02-25 11:35 ` Joseph Myers
2015-02-25 11:40 ` Arnaud Charlet
2015-02-25 15:43 ` Joseph Myers
2015-02-25 15:50 ` Arnaud Charlet
2015-02-25 16:00 ` Joseph Myers
2015-02-26 17:18 ` David Malcolm
2015-02-26 17:26 ` Arnaud Charlet
2015-02-26 18:33 ` Mike Stump
2015-03-03 10:42 ` Matthias Klose
2015-03-03 13:33 ` Arnaud Charlet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20150220091720.GA16093@adacore.com \
--to=charlet@adacore.com \
--cc=gcc-patches@gcc.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).