-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add textual elaborations and python docs
- Loading branch information
TCY16
committed
Dec 10, 2021
1 parent
19ebffb
commit 77edd0d
Showing
4 changed files
with
57 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,48 @@ | ||
Python Modules | ||
-------------- | ||
|
||
This section talks about Python modules for Unbound. Using Unbound from | ||
Python is discussed in the libunbound section. | ||
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. | ||
|
||
.. code:: bash | ||
./configure --with-pyunbound | ||
We can then generate the documentation for this using: | ||
|
||
.. code:: bash | ||
make doc | ||
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`. | ||
|
||
.. 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. | ||
|
||
./configure --with-pythonmodule | ||
|
||
The full documentation for it can be build using: | ||
|
||
We can then generate the documentation for this using: | ||
|
||
.. code:: bash | ||
make doc | ||
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`. | ||
|
||
.. code:: bash | ||
sphinx-build -b html pythonmod/doc/ doc/html/pythonmod/ |