wipsphinx-manpage

11 files changed, 83 insertions, 52 deletions

diff --git a/CMakeLists.txt b/CMakeLists.txt
index e217171..d9ce907 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -2,9 +2,9 @@ cmake_minimum_required(VERSION 3.0)
 
 project(biboumi)
 
-set(${PROJECT_NAME}_VERSION_MAJOR 9)
-set(${PROJECT_NAME}_VERSION_MINOR 0)
-set(${PROJECT_NAME}_VERSION_SUFFIX "~dev")
+add_subdirectory(doc)
+
+include("version.cmake")
 
 if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS 5.0)
@@ -47,12 +47,12 @@ endif()
 set(ARCHIVE_NAME ${CMAKE_PROJECT_NAME}-${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR})
 set(RPM_VERSION ${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR})
 
-if(${PROJECT_NAME}_VERSION_SUFFIX MATCHES ".+")
-  set(ARCHIVE_NAME ${ARCHIVE_NAME}${${PROJECT_NAME}_VERSION_SUFFIX})
-  set(RPM_VERSION ${RPM_VERSION}${${PROJECT_NAME}_VERSION_SUFFIX})
+if(${PROJECT_NAME}_VERSION_TWEAK MATCHES ".+")
+  set(ARCHIVE_NAME ${ARCHIVE_NAME}${${PROJECT_NAME}_VERSION_TWEAK})
+  set(RPM_VERSION ${RPM_VERSION}${${PROJECT_NAME}_VERSION_TWEAK})
 endif()
 
-if(${PROJECT_NAME}_VERSION_SUFFIX MATCHES "^~dev$")
+if(${PROJECT_NAME}_VERSION_TWEAK MATCHES "^~dev$")
   # If we are on a dev version, append the hash of the current git HEAD to
   # the version
   include(FindGit)
@@ -61,7 +61,7 @@ if(${PROJECT_NAME}_VERSION_SUFFIX MATCHES "^~dev$")
       OUTPUT_VARIABLE GIT_REVISION
       OUTPUT_STRIP_TRAILING_WHITESPACE)
     if(GIT_REVISION)
-      set(${PROJECT_NAME}_VERSION_SUFFIX "${${PROJECT_NAME}_VERSION_SUFFIX} (${GIT_REVISION})")
+      set(${PROJECT_NAME}_VERSION_TWEAK "${${PROJECT_NAME}_VERSION_TWEAK} (${GIT_REVISION})")
       set(ARCHIVE_NAME ${ARCHIVE_NAME}${GIT_REVISION})
       set(RPM_VERSION ${RPM_VERSION}${GIT_REVISION})
     endif()
@@ -69,13 +69,7 @@ if(${PROJECT_NAME}_VERSION_SUFFIX MATCHES "^~dev$")
 endif()
 
 set(SOFTWARE_VERSION
-  ${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}${${PROJECT_NAME}_VERSION_SUFFIX})
-
-#
-## The rule that generates the documentation
-#
-add_custom_target(doc COMMAND make html BUILDDIR=${CMAKE_CURRENT_BINARY_DIR}
-                  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc)
+  ${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}${${PROJECT_NAME}_VERSION_TWEAK})
 
 #
 ## Set this search path for cmake, to find our custom search modules
@@ -343,7 +337,7 @@ add_custom_target(everything DEPENDS test_suite biboumi)
 ## Install target
 #
 install(TARGETS ${PROJECT_NAME} RUNTIME                     DESTINATION bin)
-install(FILES   ${MAN_PAGE}                                 DESTINATION share/man/man1         OPTIONAL COMPONENT documentation)
+install(FILES   ${MAN_OUTPUT}                               DESTINATION share/man/man1         OPTIONAL COMPONENT documentation)
 install(FILES   ${CMAKE_CURRENT_BINARY_DIR}/biboumi.service DESTINATION lib/systemd/system     COMPONENT init)
 file(GLOB policy_files conf/*policy.txt)
 install(FILES   ${policy_files}                             DESTINATION /etc/biboumi           COMPONENT configuration)
diff --git a/cmake/Modules/FindGCRYPT.cmake b/cmake/Modules/FindGCRYPT.cmake
index b73bfd0..cd51c1f 100644
--- a/cmake/Modules/FindGCRYPT.cmake
+++ b/cmake/Modules/FindGCRYPT.cmake
@@ -16,7 +16,10 @@
 # This file is in the public domain
 
 include(FindPkgConfig)
-pkg_check_modules(GCRYPT gcrypt)
+
+if(NOT GCRYPT_FOUND)
+  pkg_check_modules(GCRYPT gcrypt)
+endif()
 
 if(NOT GCRYPT_FOUND)
   find_path(GCRYPT_INCLUDE_DIRS NAMES gcrypt.h
diff --git a/cmake/Modules/FindSPHINX.cmake b/cmake/Modules/FindSPHINX.cmake
new file mode 100644
index 0000000..c39b827
--- /dev/null
+++ b/cmake/Modules/FindSPHINX.cmake
@@ -0,0 +1,12 @@
+find_program(SPHINX_BIN
+    NAMES sphinx-build
+    HINTS $ENV{SPHINX_DIR}
+    PATH_SUFFIXES bin
+    DOC "Sphinx executable to build the documentation"
+)
+
+include(FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args(SPHINX REQUIRED_VARS SPHINX_BIN)
+
+mark_as_advanced(SPHINX_EXECUTABLE)
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 0000000..100550a
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1,37 @@
+cmake_minimum_required(VERSION 3.0)
+
+project(biboumi_doc NONE)
+
+include("../version.cmake")
+
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/../cmake/Modules/")
+find_package(SPHINX)
+
+if(SPHINX_FOUND)
+  configure_file(conf.py.cmake conf.py)
+
+  set(SPHINX_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build")
+
+  set(HTML_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/html)
+  set(MAN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/man)
+  set(MAN_OUTPUT ${MAN_OUTPUT_DIR}/biboumi.1 PARENT_SCOPE)
+  set(MAN_OUTPUT ${MAN_OUTPUT_DIR}/biboumi.1)
+    message("${CMAKE_CURRENT_BINARY_DIR}")
+  add_custom_command(OUTPUT ${HTML_OUTPUT_DIR}
+      COMMAND ${SPHINX_BIN}
+      -b html -q
+      -c ${CMAKE_CURRENT_BINARY_DIR}
+      ${CMAKE_CURRENT_SOURCE_DIR}
+      ${HTML_OUTPUT_DIR})
+  add_custom_command(OUTPUT ${MAN_OUTPUT}
+      WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+      COMMAND ${SPHINX_BIN}
+      -b man -q
+      -c ${CMAKE_CURRENT_BINARY_DIR}
+      ${CMAKE_CURRENT_SOURCE_DIR}
+      ${MAN_OUTPUT_DIR})
+  add_custom_target(doc ALL
+      DEPENDS ${HTML_OUTPUT_DIR} ${MAN_OUTPUT})
+else()
+  add_custom_target(doc COMMAND ${CMAKE_COMMAND} -E echo "sphinx-build is required to build the doc")
+endif()
diff --git a/doc/Makefile b/doc/Makefile
deleted file mode 100644
index 934bdf7..0000000
--- a/doc/Makefile
+++ /dev/null
@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = biboumi
-SOURCEDIR     = .
-BUILDDIR      = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
diff --git a/doc/admin.rst b/doc/admin.rst
index a5850a7..b51e13b 100644
--- a/doc/admin.rst
+++ b/doc/admin.rst
@@ -10,7 +10,7 @@ background for as long as it is needed.  Note that biboumi does not
 daemonize itself, this task should be done by your init system (SysVinit,
 systemd, upstart).
 
-When started, biboumi connects, without encryption (see :ref:`Security`), to the
+When started, biboumi connects, without encryption (see :ref:`security`), to the
 local XMPP server on the port ``5347`` and authenticates with the provided
 password.  Biboumi then serves the configured ``hostname``: this means that
 all XMPP stanza with a `to` JID on that domain will be forwarded to biboumi
@@ -34,7 +34,7 @@ Configuration happens in different places, with different purposes:
   configuration, and this is described in the next section.
 - A TLS configuration, also admin-only, that can be either global or
   per-domain. See `TLS configuration`_ section.
-- Using the :ref:`ad-hoc commands`, each user can configure various
+- Using the :ref:`ad-hoc-commands`, each user can configure various
   settings for themself
 
 Daemon configuration
@@ -157,7 +157,7 @@ If it is set to false (the default value), all rooms are not persistent by
 default.
 
 Each room can be configured individually by each user, to override this
-default value. See :ref:`Ad-hoc commands`.
+default value. See :ref:`ad-hoc-commands`.
 
 realname_customization
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -277,6 +277,7 @@ the certificate validity at all. The default value is true.
 By default, biboumi provides a few policy files, to work around some
 issues found with a few well-known IRC servers.
 
+.. _security:
 
 Security
 ========
diff --git a/doc/conf.py b/doc/conf.py.cmake
index e3f0e02..22707fe 100644
--- a/doc/conf.py
+++ b/doc/conf.py.cmake
@@ -24,9 +24,9 @@ copyright = '2018, Florent Le Coz'
 author = 'Florent Le Coz'
 
 # The short X.Y version
-version = '8.3'
+version = '${biboumi_VERSION_MAJOR}.${biboumi_VERSION_MINOR}'
 # The full version, including alpha/beta/rc tags
-release = '8.3'
+release = version + '${biboumi_VERSION_TWEAK}'
 
 
 # -- General configuration ---------------------------------------------------
@@ -40,7 +40,6 @@ release = '8.3'
 # ones.
 extensions = [
     'sphinx.ext.coverage',
-    'sphinx.ext.autosectionlabel',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -87,7 +86,7 @@ html_theme = 'sphinx_rtd_theme'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -140,7 +139,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'biboumi', 'biboumi Documentation',
+    ('admin', 'biboumi', 'Administrator documentation',
      [author], 1)
 ]
 
diff --git a/doc/contributing.rst b/doc/contributing.rst
index ee499fc..5d63b5d 100644
--- a/doc/contributing.rst
+++ b/doc/contributing.rst
@@ -91,7 +91,7 @@ Please try to follow the existing style:
 - Use only spaces, not tabs.
 - Curly brackets are on their own lines.
 - Use this-> everywhere it’s possible.
-- Don’t start class attributes with “m_” or similar.
+- Don’t start class attributes with `m_` or similar.
 - Type names are in PascalCase.
 - Everything else is in snake_case.
 
diff --git a/doc/user.rst b/doc/user.rst
index 505e3b9..0405606 100644
--- a/doc/user.rst
+++ b/doc/user.rst
@@ -330,6 +330,8 @@ Affiliation set to ``admin``
 Affiliation set to ``owner``
   Sets mode to +a-q
 
+.. _ad-hoc-commands:
+
 Ad-hoc commands
 ---------------
 
diff --git a/packaging/biboumi.spec.cmake b/packaging/biboumi.spec.cmake
index c841cdc..ce4b36e 100644
--- a/packaging/biboumi.spec.cmake
+++ b/packaging/biboumi.spec.cmake
@@ -16,7 +16,7 @@ BuildRequires: postgresql-devel
 BuildRequires: botan2-devel
 BuildRequires: cmake
 BuildRequires: systemd
-BuildRequires: pandoc
+BuildRequires: /usr/bin/sphinx-build
 
 %global _hardened_build 1
 
@@ -68,13 +68,13 @@ make check %{?_smp_mflags}
 - Build latest git revision
 - Build against botan2
 
-* Wed Jun 1 2018 Le Coz Florent <louiz@louiz.org> - 8.3-1
+* Fri Jun 1 2018 Le Coz Florent <louiz@louiz.org> - 8.3-1
   Update to version 8.3
 
-* Wed May 25 2018 Le Coz Florent <louiz@louiz.org> - 8.2-1
+* Fri May 25 2018 Le Coz Florent <louiz@louiz.org> - 8.2-1
   Update to version 8.2
 
-* Wed May 14 2018 Le Coz Florent <louiz@louiz.org> - 8.1-1
+* Mon May 14 2018 Le Coz Florent <louiz@louiz.org> - 8.1-1
   Update to version 8.1
 
 * Wed May 2 2018 Le Coz Florent <louiz@louiz.org> - 8.0-1
@@ -83,7 +83,7 @@ make check %{?_smp_mflags}
 * Wed Jan 24 2018 Le Coz Florent <louiz@louiz.org> - 7.2-1
   Update to version 7.2
 
-* Wed Jan 22 2018 Le Coz Florent <louiz@louiz.org> - 7.1-1
+* Mon Jan 22 2018 Le Coz Florent <louiz@louiz.org> - 7.1-1
   Update to version 7.1
 
 * Wed Jan 17 2018 Le Coz Florent <louiz@louiz.org> - 7.0-1
@@ -98,7 +98,7 @@ make check %{?_smp_mflags}
 * Wed May 24 2017 Le Coz Florent <louiz@louiz.org> - 5.0-1
 - Update to version 5.0
 
-* Wed May 2 2017 Le Coz Florent <louiz@louiz.org> - 4.3-1
+* Tue May 2 2017 Le Coz Florent <louiz@louiz.org> - 4.3-1
 - Fix a segmentation fault that occured when trying to connect
   to an IRC server without any port configured.
 
diff --git a/version.cmake b/version.cmake
new file mode 100644
index 0000000..5f1dae3
--- /dev/null
+++ b/version.cmake
@@ -0,0 +1,3 @@
+set(biboumi_VERSION_MAJOR 9)
+set(biboumi_VERSION_MINOR 0)
+set(biboumi_VERSION_TWEAK "~dev")