From 1a194a292e12c1f752afabe5a0bdc3b76706ee06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?louiz=E2=80=99?= Date: Sat, 22 Sep 2018 16:59:13 +0200 Subject: wip --- doc/CMakeLists.txt | 37 ++++++++++++ doc/Makefile | 20 ------- doc/admin.rst | 7 ++- doc/conf.py | 160 --------------------------------------------------- doc/conf.py.cmake | 159 ++++++++++++++++++++++++++++++++++++++++++++++++++ doc/contributing.rst | 2 +- doc/user.rst | 2 + 7 files changed, 203 insertions(+), 184 deletions(-) create mode 100644 doc/CMakeLists.txt delete mode 100644 doc/Makefile delete mode 100644 doc/conf.py create mode 100644 doc/conf.py.cmake (limited to 'doc') 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 deleted file mode 100644 index e3f0e02..0000000 --- a/doc/conf.py +++ /dev/null @@ -1,160 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Configuration file for the Sphinx documentation builder. -# -# This file does only contain a selection of the most common options. For a -# full list see the documentation: -# http://www.sphinx-doc.org/en/master/config - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - - -# -- Project information ----------------------------------------------------- - -project = 'biboumi' -copyright = '2018, Florent Le Coz' -author = 'Florent Le Coz' - -# The short X.Y version -version = '8.3' -# The full version, including alpha/beta/rc tags -release = '8.3' - - -# -- General configuration --------------------------------------------------- - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.coverage', - 'sphinx.ext.autosectionlabel', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path . -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'sphinx_rtd_theme' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# 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'] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# The default sidebars (for documents that don't match any pattern) are -# defined by theme itself. Builtin themes are using these templates by -# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', -# 'searchbox.html']``. -# -# html_sidebars = {} - - -# -- Options for HTMLHelp output --------------------------------------------- - -# Output file base name for HTML help builder. -htmlhelp_basename = 'biboumidoc' - - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'biboumi.tex', 'biboumi Documentation', - 'Florent Le Coz', 'manual'), -] - - -# -- Options for manual page output ------------------------------------------ - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'biboumi', 'biboumi Documentation', - [author], 1) -] - - -# -- Options for Texinfo output ---------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'biboumi', 'biboumi Documentation', - author, 'biboumi', 'One line description of project.', - 'Miscellaneous'), -] - - -# -- Extension configuration ------------------------------------------------- diff --git a/doc/conf.py.cmake b/doc/conf.py.cmake new file mode 100644 index 0000000..22707fe --- /dev/null +++ b/doc/conf.py.cmake @@ -0,0 +1,159 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'biboumi' +copyright = '2018, Florent Le Coz' +author = 'Florent Le Coz' + +# The short X.Y version +version = '${biboumi_VERSION_MAJOR}.${biboumi_VERSION_MINOR}' +# The full version, including alpha/beta/rc tags +release = version + '${biboumi_VERSION_TWEAK}' + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.coverage', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# 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 = [] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'biboumidoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'biboumi.tex', 'biboumi Documentation', + 'Florent Le Coz', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('admin', 'biboumi', 'Administrator documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'biboumi', 'biboumi Documentation', + author, 'biboumi', 'One line description of project.', + 'Miscellaneous'), +] + + +# -- Extension configuration ------------------------------------------------- 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 --------------- -- cgit v1.2.3