Generate texinfo documentation properly

There was a texinfo documentation that was being generated up to now,
but I haven't really looked at it.  Now that I have handled man pages
generation, I thought I'd give the texinfo generation a closer look
and ensure it's in a correct shape.  This patch cleans the generation
process up, changes the documentation markup so that it looks OK in
the generated texinfo file and handles the install of the generated
texinfo.

	* doc/manuals/Makefile.am: Generate texinfo doc, install it and
	uninstall it.
	* doc/manuals/libabigail-tools.rst: Do not use the :doc: syntax to
	refer to documents because it doesn't seem to work with sphinx
	right now.  Rather, use a table of content.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
This commit is contained in:
Dodji Seketeli 2015-01-13 18:10:19 +01:00
parent 69c9f1fbcd
commit 5059907727
3 changed files with 22 additions and 7 deletions

View File

@ -161,13 +161,17 @@ doctest:
"results in $(BUILDDIR)/doctest/output.txt."
manpages =
texinfodocs =
if ENABLE_MANUAL
manpages += abidiff.7 abidw.7 abilint.7 abicompat.7 libabigail.7
texinfodocs += abigail.info
install-html-doc: html-doc
test -d "$(DESTDIR)$(docdir)/manual" || $(mkinstalldirs) "$(DESTDIR)$(docdir)/manual"
cp -r "$(DESTDIR)$(BUILDDIR)/html" "$(DESTDIR)$(docdir)/manual"
endif
clean-local:
@ -178,5 +182,10 @@ install-data-local:
-test -f $(BUILDDIR)/man/abidiff.7 && $(mkinstalldirs) $(DESTDIR)$(mandir)/man7
-for m in $(manpages); do test -f $(BUILDDIR)/man/$$m && $(install_sh_DATA) $(BUILDDIR)/man/$$m $(DESTDIR)$(mandir)/man7; done;
-test -f $(BUILDDIR)/texinfo/abidiff.info && $(mkinstalldirs) $(DESTDIR)$(infodir)
-for i in $(texinfodocs); do test -f $(BUILDDIR)/texinfo/$$i && $(install_sh_DATA) $(BUILDDIR)/texinfo/$$i $(DESTDIR)$(infodir)/$$i; done;
uninstall-local: clean-local
-for i in $$(manpages); do rm -f $(DESTDIR)$(mandir)/man7/$$i; done
-for i in $$(texinfodocs); do rm -f $(DESTDIR)$(infodir)/$$i; done
-rm -rf $(DESTDIR)$(docdir)/manual/html

View File

@ -230,9 +230,13 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Libabigailmanuals', u'Libabigail manuals Documentation',
u'Dodji Seketeli', 'Libabigailmanuals', 'One line description of project.',
'Miscellaneous'),
('index',
'abigail',
'Comparing Applications Binary Interfacces of binaries in ELF format',
'Dodji Seketeli',
'abigail',
'compare the ABI of ELF binaries',
'Individual utilities'),
]
# Documents to append as an appendix to all manuals.

View File

@ -12,8 +12,10 @@ of the project.
Tools manuals
=============
* :doc:`abidiff`
* :doc:`abicompat`
* :doc:`abidw`
* :doc:`abilint`
.. toctree::
:maxdepth: 2
abidiff
abicompat
abidw
abilint