Skip to content

Commit

Permalink
Restructure
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderBand committed Dec 11, 2021
1 parent faeb621 commit e4d86df
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 11 deletions.
8 changes: 8 additions & 0 deletions source/developer/doxygen-docs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _doc_doxygen:

Source Code Docs
================

The automatically generated documentation of the Unbound source code is
available in on `the NLnet Labs website
<https://www.nlnetlabs.nl/documentation/unbound/doxygen/>`_.
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
.. _doc_pyunbound:

Unbound for Python
------------------
==================

Pyunbound
*********
---------

Unbound supports bindings for Python which we call 'pyunbound'. We enable this functionility in the :command:`configure` step of the installation using the following command.
Unbound supports bindings for Python which we call 'pyunbound'. We enable this
functionility in the :command:`configure` step of the installation using the
following command.

.. code:: bash
Expand All @@ -16,20 +20,27 @@ We can then generate the documentation for this using:
make doc
This command will genereate the docs in ``doc/html/pyunbound``, which can be browsed in a webbrowser by opening ``index.html``.
This command will genereate the docs in ``doc/html/pyunbound``, which can be
browsed in a webbrowser by opening ``index.html``.

Another option of gereating the files is available if you are using :command:`sphinx`.
Another option of gereating the files is available if you are using
:command:`sphinx`.

.. code:: bash
sphinx-build -b html libunbound/python/doc doc/html/pyunbound/
Pythonmod
*********
---------

Unbound also contains a module that executes python code called "pythonmod". The
supplied Python code has to follow module operation semantics. This module is
enabled in the :command:`configure` step of the installation using the following
command.

Unbound also contains a module that executes python code called "pythonmod". The supplied Python code has to follow module operation semantics. This module is enabled in the :command:`configure` step of the installation using the following command.
.. code:: bash
./configure --with-pythonmodule
./configure --with-pythonmodule
The full documentation for it can be build using:

Expand All @@ -39,9 +50,11 @@ We can then generate the documentation for this using:
make doc
This command will genereate the docs in ``doc/html/pythonmod``, which can be browsed in a webbrowser by opening ``index.html``.
This command will genereate the docs in ``doc/html/pythonmod``, which can be
browsed in a webbrowser by opening ``index.html``.

Another option of gereating the files is available if you are using :command:`sphinx`.
Another option of gereating the files is available if you are using
:command:`sphinx`.

.. code:: bash
Expand Down
3 changes: 2 additions & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ license, with attribution to NLnet Labs.
:caption: Developer

developer/libunbound-tutorial/index
internals/python-modules
developer/python-modules
developer/doxygen-docs

.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit e4d86df

Please sign in to comment.