smallsolar
/
libkiwix
mirror of https://github.com/kiwix/libkiwix.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #790 from kiwix/docTypo

This commit is contained in:
Kelson 2022-06-25 07:38:28 +02:00 committed by GitHub
parent 15cb9025bb e9b7eeb3c9
commit b9e03d2772
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.py
View File

@ -19,7 +19,7 @@ import os
project = 'libkiwix' project = 'libkiwix'
copyright = '2022, libkiwix-team' copyright = '2022, libkiwix-team'
author = 'libzim-team' author = 'libkiwix-team'
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------

2
docs/index.rst
View File

@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to libzim's documentation! Welcome to libkiwix's documentation!
================================== ==================================
.. toctree:: .. toctree::

4
docs/usage.rst
View File

@ -7,11 +7,9 @@ Introduction
libkiwix is written in C++. To use the library, you need the include files of libkiwix have libkiwix is written in C++. To use the library, you need the include files of libkiwix have
to link against libzim. to link against libzim.
Errors are handled with exceptions. When something goes wrong, libzim throws an error, Errors are handled with exceptions. When something goes wrong, libkiwix throws an error,
which is always derived from std::exception. which is always derived from std::exception.
All classes are defined in the namespace kiwix. All classes are defined in the namespace kiwix.
libkiwix is a set of tools to manage zim files and provide some common functionnality. libkiwix is a set of tools to manage zim files and provide some common functionnality.
While libkiwix has some wrappers around libzim classes, they are deprecated and will be removed
in the future.