From 5d8b4a1811d2cdf240a89a84b8782a31ab04a7f3 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Picca=20Fr=C3=A9d=C3=A9ric-Emmanuel?= Date: Wed, 21 Jan 2015 10:11:49 +0100 Subject: [PATCH] add --disable-hkl-doc option to no build the documentation --- Documentation/hkl.org.in | 42 +++++++++++++++++++++++------------------- Makefile.am | 5 ++++- configure.ac | 24 +++++++++++------------- 3 files changed, 38 insertions(+), 33 deletions(-) diff --git a/Documentation/hkl.org.in b/Documentation/hkl.org.in index 5b51f5eb..7d1ec555 100644 --- a/Documentation/hkl.org.in +++ b/Documentation/hkl.org.in @@ -4,7 +4,6 @@ #+LANGUAGE: en #+HTML_MATHJAX: path:"/usr/share/javascript/mathjax/MathJax.js" #+STYLE: -#+INFOJS_OPT: view:info toc:nil * Introduction The purpose of the library is to factorise single crystal @@ -434,8 +433,7 @@ [[./figures/e2k_4.png]] ** Qper and Qpar - [[ - ./figures/qper_qpar.png]] + [[./figures/qper_qpar.png]] this pseudo axis engine compute the perpendicular ($\left|\left|\vec{Q_\text{per}}\right|\right|$) and parallel @@ -557,26 +555,31 @@ git clone git://repo.or.cz/hkl.git if you want to work on the documentation you need the extra -- [[http://www.gtk.org/gtk-doc/][gtk-doc]] for the api -- [[http://sphinx.pocoo.org/][sphinx]] for the html and latex doc. -- [[http://asymptote.sourceforge.net/][asymptote]] for the figures -- [[http://www.gnu.org/software/emacs/][emacs]] the well known editor -- [[https://github.com/emacsmirror/htmlize][htmlize]] used to highlight the source code -- [[http://orgmode.org][org-mode]] litteral programming -- [[http://savannah.nongnu.org/projects/dvipng/][dvipng]] convert latex equation into pictures + - [[http://www.gtk.org/gtk-doc/][gtk-doc]] for the api + - [[http://sphinx.pocoo.org/][sphinx]] for the html and latex doc. + - [[http://asymptote.sourceforge.net/][asymptote]] for the figures + - [[http://www.gnu.org/software/emacs/][emacs]] the well known editor + - [[https://github.com/emacsmirror/htmlize][htmlize]] used to highlight the source code + - [[http://orgmode.org][org-mode]] litteral programming -On Debian/Ubuntu you just need to install + On Debian/Ubuntu you just need to install -#+BEGIN_SRC sh - sudo apt-get install emacs dvipng emacs-goodies-el org-mode -#+END_SRC + #+BEGIN_SRC sh + sudo apt-get install emacs dvipng emacs-goodies-el org-mode + #+END_SRC -#+BEGIN_SRC sh + #+BEGIN_SRC sh ./configure --enable-gtk-doc make make html #+END_SRC + nevertheless if you do not want to build the documentation you can do: + + #+BEGIN_SRC sh + ./configure --disable-hkl-doc + #+END_SRC + ** Hacking hkl *** Bug reporting @@ -833,10 +836,10 @@ On Debian/Ubuntu you just need to install Investigate [[http://liboil.freedesktop.org/wiki/][liboil]] to speed calculation (in HklVector, HklMatrix and HklQuaternion) ** documentation -*** TODO [1/4] rewrite documentation in org-mode - - [ ] embed code into the org-mode - - [ ] [0/4] python - - [ ] auto generation of the diffractometer descriptions +*** TODO [1/5] rewrite documentation in org-mode + - [-] embedding code into the org file + - [-] [1/4] python + - [X] auto generation of the diffractometer descriptions - [ ] trajectories explanations - [ ] trajectories tests. - [ ] unit tests output ? @@ -845,6 +848,7 @@ On Debian/Ubuntu you just need to install python binding for all diffractometer geometries. - [ ] need to add a description for the diffractometer, the mode, the parameters. - [ ] need a nice css for the generated doc. + - [ ] check if org-info.js could be usefull ** gui *** TODO change the color of fitparameter cells if they differ from the current sample values diff --git a/Makefile.am b/Makefile.am index e8045707..28984817 100644 --- a/Makefile.am +++ b/Makefile.am @@ -10,7 +10,10 @@ endif if GUI SUBDIRS += gui endif -SUBDIRS += tests Documentation +if HKL_DOC +SUBDIRS += Documentation +endif +SUBDIRS += tests EXTRA_DIST = hkl.pc.in hkl3d.pc.in diff --git a/configure.ac b/configure.ac index c86282f8..4de559ad 100644 --- a/configure.ac +++ b/configure.ac @@ -122,23 +122,21 @@ AM_COND_IF([LOGGING], AC_DEFINE([LOGGING], [1], [activate the logging or not]) ) -dnl *************** -dnl *** gtk-doc *** -dnl *************** - -GTK_DOC_CHECK([1.9],[--flavour no-tmpl]) - dnl *********** -dnl *** asy *** +dnl *** doc *** dnl *********** -AC_PATH_PROG([ASY], [asy], [echo]) - -dnl ************* -dnl *** emacs *** -dnl ************* +OPTION_DEFAULT_ON([hkl-doc], [build documentation]) +AM_CONDITIONAL([HKL_DOC], [test x$enable_hkl_doc = xyes]) +AM_COND_IF([HKL_DOC], + [dnl *** asymptote *** + AC_PATH_PROG([ASY], [asy], [echo]) + dnl *** emacs *** + AC_PATH_PROG([EMACS], [emacs], [no]) + ]) -AC_PATH_PROG([EMACS], [emacs], [no]) +dnl *** gtk-doc *** +GTK_DOC_CHECK([1.9],[--flavour no-tmpl]) dnl ******************************* dnl *** add an option for hkl3d *** -- 2.11.4.GIT