This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Re: [jit] Add sphinx-based documentation for libgccjit
- From: Mike Stump <mikestump at comcast dot net>
- To: David Malcolm <dmalcolm at redhat dot com>
- Cc: jit at gcc dot gnu dot org, gcc-patches at gcc dot gnu dot org
- Date: Thu, 18 Sep 2014 08:29:55 -0700
- Subject: Re: [jit] Add sphinx-based documentation for libgccjit
- Authentication-results: sourceware.org; auth=none
- References: <1411003363-32146-1-git-send-email-dmalcolm at redhat dot com>
On Sep 17, 2014, at 6:22 PM, David Malcolm <dmalcolm@redhat.com> wrote:
> I greatly prefer to use Sphinx over Texinfo, both for the ease of
> editing, and the quality of the generated HTML; I already use it for
> both the Python bindings to libgccjit, and for gcc-python-plugin.
> Hence I've used Sphinx for these docs. It's trivial to build texinfo
> and info files from it (assuming you have sphinx installed).
So, I’d recommend for you to additionally generate and build the texinfo and possibly the html source from it and check that in as a generated file. That way, no one has to have the package and all the builds and installs just work as normal. People that want to edit those file, which will be few, would then just install that package and regenerate and check it in. People doing spelling corrections and the like, could just edit the source and let someone else regenerate as well.