diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 8 | ||||
| -rw-r--r-- | doc/install.txt | 17 |
2 files changed, 25 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py index 371480e..2019127 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -54,6 +54,14 @@ version = libbe.version.version() # The full version, including alpha/beta/rc tags. release = libbe.version.version() +# Override default sphinx.config.Config.configvalues[html_title] to +# change formatting string from '%s v%s' to '%s %s'. With git-commit +# versions, the original formatting string gives titles like +# bugs-everywhere vc07c687273afc1f38258d3fa5caf39244c0d1b33 +# which may suprise users who don't realize the leading 'v' is not +# part of the hash. +html_title = '%s %s documentation' % (project, release) + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None diff --git a/doc/install.txt b/doc/install.txt index 7278c01..5752566 100644 --- a/doc/install.txt +++ b/doc/install.txt @@ -54,7 +54,24 @@ to install BE. By default BE will install into your home directory, but you can tweak the ``PREFIX`` variable in ``Makefile`` to install to another location. +By default, ``make`` builds both a man page for ``be`` and the HTML +Sphinx documentation (:doc:`doc`). You can customize the +documentation targets by overriding_ the ``DOC`` variable. For +example, to disable all documentation during a build/install, run:: + + $ make DOC= install + +Note that ``setup.py`` (called during ``make install``) will install +the man page (``doc/man/be.1``) if it exists, so:: + + $ make + $ make DOC= install + +*will* build (first ``make``) install (second ``make``) the man page. + + .. _homepage: http://bugseverywhere.org/ +.. _overriding: http://www.gnu.org/software/make/manual/html_node/Overriding.html#Overriding Release tarballs |