mirror of
https://github.com/kiwix/libkiwix.git
synced 2026-04-17 20:57:15 -04:00
34fc831c13
Documentation of libkiwix API has been largely neglected. This commit documents the Server API having to do with the functionality fixed in the previous commit.
69 lines
2.1 KiB
Python
69 lines
2.1 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- 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 = 'libkiwix'
|
|
copyright = '2026, libkiwix-team'
|
|
author = 'libkiwix-team'
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'breathe',
|
|
'exhale'
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# 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']
|
|
|
|
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']
|
|
|
|
breathe_projects = {
|
|
"libkiwix": "./xml"
|
|
}
|
|
breathe_default_project = 'libkiwix'
|
|
|
|
exhale_args = {
|
|
"containmentFolder": "./api",
|
|
"rootFileName": "ref_api.rst",
|
|
"rootFileTitle": "Reference API",
|
|
"doxygenStripFromPath":"..",
|
|
"treeViewIsBootstrap": True,
|
|
"createTreeView" : True,
|
|
"exhaleExecutesDoxygen": True,
|
|
"exhaleDoxygenStdin": "INPUT = ../include"
|
|
}
|
|
|
|
primary_domain = 'cpp'
|
|
|
|
highlight_language = 'cpp'
|