Commit 4220f06f authored by Ales Mrazek's avatar Ales Mrazek

basic sphinx documentation structure

parent a6481e45
......@@ -75,7 +75,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
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
......@@ -110,7 +110,7 @@ htmlhelp_basename = 'Resolvers-YANGdoc'
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
'papersize': 'a4paper',
# The font size ('10pt', '11pt' or '12pt').
#
......
**************************
Examples
**************************
\ No newline at end of file
......@@ -3,13 +3,22 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Resolvers-YANG's documentation!
Resolvers-YANG
==========================================
YANG data models, python3 library and tools for unified configuration of DNS resolvers.
* `Knot Resolver`_
* Unbound_
.. toctree::
:maxdepth: 2
:caption: Contents:
installation
model
library
examples
Indices and tables
......@@ -18,3 +27,7 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _Knot Resolver: https://www.knot-resolver.cz/
.. _Unbound: https://www.unbound.net/
\ No newline at end of file
**************************
Getting Started
**************************
\ No newline at end of file
**************************
Library Functions
**************************
\ No newline at end of file
***************
YANG Data Model
***************
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment