aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Makefile.local
Commit message (Collapse)AuthorAge
* doc: 'rm -f' potential doxygen temporary output fileGravatar Tomi Ollila2014-09-02
| | | | Some (older) Doxygen versions do not create such a temporary file.
* docs: remove spurious man page generated from doxygenGravatar David Bremner2014-07-13
| | | | | | | | | There is a doxygen bug about these odd files, https://bugzilla.gnome.org/show_bug.cgi?id=727796 But it isn't clear if / when a fix will be provided, so just delete it to avoid e.g. confusing man-to-wiki.pl
* doc: postprocess notmuch.3Gravatar David Bremner2014-07-09
| | | | | | Remove excess italics from doxygen output. It seems to make no sense (and is certainly ugly) to italicize the first argument to the .RI macro.
* doc: build and install doxygen api docsGravatar David Bremner2014-07-09
| | | | | In order to support out of tree builds and avoid hardcoding version number, generate `doc/config.dox` from configure.
* doc: remove conf.pyc on cleanGravatar David Bremner2014-04-22
| | | | | This build artifict messes up the packaging process for (at least) Debian if not removed on clean.
* doc: Fix parallel build of roff filesGravatar Austin Clements2014-04-19
| | | | | | | | | | The roff build rule builds all of the roff files in a single command. Previously, this was expressed as a multi-target rule, but since this is equivalent to specifying a copy of the rule for each target, make -jN could start up to N parallel instances of this command. Fix this by bottlenecking this rule through a single stamp file. This also removes the unused man.stamp from CLEAN.
* doc: fix out-of-tree buildGravatar David Bremner2014-03-25
| | | | | | | | The subtle part is adding .rst and .py files to vpath so they can be used as dependencies without prefixing with $(srcdir) We also change the interface to mkbuildeps.py: rather than getting the containing directory from the conf file path, we go the other way.
* doc: configure detection of sphinx and rst2manGravatar David Bremner2014-03-18
| | | | | | | | | Because sphinx-build does not provide a convenient way of listing which builders exist, and some people actually have pre 1.0 sphinx, we try loading a relevant python module. Currently the assumption is that no python in path -> no sphinx-build in path.
* doc: build man pages into hierarchy, fix help test.Gravatar David Bremner2014-03-18
| | | | | | | | | It turns out there was a reason the old man pages were stored in a man compatible hierarchy, namely so that we could run man on them before installing. Hardcode doc build location into test suite. This isn't ideal, but let's unbreak the test suite for now.
* doc: build man pages at build time; introduce HAVE_SPHINX, HAVE_RST2MANGravatar David Bremner2014-03-18
| | | | | | | | This helps avoid build artifacts (namely, nroff and gzipped-nroff man pages) owned by root. The variables allow choosing which generator to use for the man page. These will be hooked to configure in a following commit.
* doc: install sphinx version of man pagesGravatar David Bremner2014-03-09
| | | | | | | | The python script mkdocdeps.py is used to import the list of man pages from the sphinx configuration to make. This will delete the (release only) target update-man-versions. This will be replaced in a followup commit.
* doc: add target rst2man to build man pages using rst2manGravatar David Bremner2014-03-09
| | | | | Many people have docutils installed, but not sphinx. Allow these people to build the man pages.
* doc: convert sphinx based docsGravatar David Bremner2014-03-09
This is the output from sphinx-quickstart, massaged a bit, along with our existing man pages converted to rst. A skeleton notmuch-emacs manual is also included. It is not suitable for end user use yet.