* doc/DoxygenLayout.xml: Change menu. * doc/Makefile.am: Do not use relative paths. --- scribo/ChangeLog | 8 ++++++++ scribo/doc/DoxygenLayout.xml | 32 ++++++++++++++++++-------------- scribo/doc/Makefile.am | 6 +++--- 3 files changed, 29 insertions(+), 17 deletions(-) diff --git a/scribo/ChangeLog b/scribo/ChangeLog index c7e0de2..7574af9 100644 --- a/scribo/ChangeLog +++ b/scribo/ChangeLog @@ -1,3 +1,11 @@ +2013-03-08 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + + Improve documentation layout. + + * doc/DoxygenLayout.xml: Change menu. + + * doc/Makefile.am: Do not use relative paths. + 2012-02-28 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; Disable the use of installdox and fix doc location. diff --git a/scribo/doc/DoxygenLayout.xml b/scribo/doc/DoxygenLayout.xml index ac34f54..e9d1901 100644 --- a/scribo/doc/DoxygenLayout.xml +++ b/scribo/doc/DoxygenLayout.xml @@ -2,24 +2,24 @@ <!-- Navigation index tabs for HTML output --> <navindex> <tab type="mainpage" visible="yes" title="Scribo"/> - <tab type="pages" visible="yes" title=""/> - <tab type="modules" visible="yes" title=""/> + <tab type="pages" visible="yes" title="" intro=""/> + <tab type="modules" visible="yes" title="" intro=""/> <tab type="namespaces" visible="yes" title=""> - <tab type="namespaces" visible="yes" title=""/> - <tab type="namespacemembers" visible="yes" title=""/> + <tab type="namespacelist" visible="yes" title="" intro=""/> + <tab type="namespacemembers" visible="yes" title="" intro=""/> </tab> <tab type="classes" visible="yes" title=""> - <tab type="classes" visible="yes" title=""/> + <tab type="classlist" visible="yes" title="" intro=""/> <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> - <tab type="hierarchy" visible="yes" title=""/> - <tab type="classmembers" visible="yes" title=""/> + <tab type="hierarchy" visible="yes" title="" intro=""/> + <tab type="classmembers" visible="yes" title="" intro=""/> </tab> <tab type="files" visible="yes" title=""> - <tab type="files" visible="yes" title=""/> - <tab type="globals" visible="yes" title=""/> + <tab type="filelist" visible="yes" title="" intro=""/> + <tab type="globals" visible="yes" title="" intro=""/> </tab> - <tab type="dirs" visible="yes" title=""/> - <tab type="examples" visible="yes" title=""/> + <tab type="dirs" visible="yes" title="" intro=""/> + <tab type="examples" visible="yes" title="" intro=""/> </navindex> <!-- Layout definition for a class page --> @@ -63,6 +63,7 @@ </memberdecl> <detaileddescription title=""/> <memberdef> + <inlineclasses title=""/> <typedefs title=""/> <enums title=""/> <constructors title=""/> @@ -90,6 +91,7 @@ </memberdecl> <detaileddescription title=""/> <memberdef> + <inlineclasses title=""/> <typedefs title=""/> <enums title=""/> <functions title=""/> @@ -117,6 +119,7 @@ </memberdecl> <detaileddescription title=""/> <memberdef> + <inlineclasses title=""/> <defines title=""/> <typedefs title=""/> <enums title=""/> @@ -131,11 +134,11 @@ <briefdescription visible="yes"/> <groupgraph visible="$GROUP_GRAPHS"/> <memberdecl> - <classes visible="yes" title=""/> - <namespaces visible="yes" title=""/> - <dirs visible="yes" title=""/> <nestedgroups visible="yes" title=""/> + <dirs visible="yes" title=""/> <files visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <classes visible="yes" title=""/> <defines title=""/> <typedefs title=""/> <enums title=""/> @@ -154,6 +157,7 @@ <detaileddescription title=""/> <memberdef> <pagedocs/> + <inlineclasses title=""/> <defines title=""/> <typedefs title=""/> <enums title=""/> diff --git a/scribo/doc/Makefile.am b/scribo/doc/Makefile.am index db72cdd..9cbe355 100644 --- a/scribo/doc/Makefile.am +++ b/scribo/doc/Makefile.am @@ -98,8 +98,8 @@ $(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) test -f $(USER_REFMAN).tmp/latex/refman.tex rm -rf $(srcdir)/$(USER_REFMAN) ## Fix path to the main page of the documentation. - sed -i -e "s,\@relcommondocpath\@,../../../user-refman/html/,g" \ - $(USER_REFMAN).tmp/html/index.html + sed -i -e "s,\@relcommondocpath\@,$(DESTDIR)$(htmldir)/$(USER_REFMAN)/html/,g" \ + `find $(USER_REFMAN).tmp -name '*.html'` ## FIXME: Moving directories between file systems is not portable. mv $(USER_REFMAN).tmp $(srcdir)/$(USER_REFMAN) @mv -f $@.tmp $@ @@ -180,7 +180,7 @@ $(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) test -f $(DEVEL_REFMAN).tmp/latex/refman.tex rm -rf $(srcdir)/$(DEVEL_REFMAN) ## Fix path to the main page of the documentation. - sed -i -e "s,\@relcommondocpath\@,../,g" \ + sed -i -e "s,\@relcommondocpath\@,$(DESTDIR)$(htmldir)/$(DEVEL_REFMAN)/html/,g" \ $(DEVEL_REFMAN).tmp/html/index.html ## FIXME: Moving directories between file systems is not portable. mv $(DEVEL_REFMAN).tmp $(srcdir)/$(DEVEL_REFMAN) -- 1.7.2.5