Commit af619f95 authored by Jan Včelák's avatar Jan Včelák 🚀

doc: fix links

parent d47ce1c8
......@@ -37,7 +37,7 @@ source_suffix = '.rst'
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'knot'
master_doc = 'index'
# General information about the project.
project = u'Knot DNS'
......@@ -120,7 +120,7 @@ html_theme = 'nature'
# 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']
#html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
......@@ -228,7 +228,8 @@ latex_documents = [
# dir menu entry, description, category)
texinfo_documents = [
('knot', 'KnotDNS', u'Knot DNS Documentation',
u'CZ.NIC, z.s.p.o.', 'KnotDNS', 'One line description of project.',
u'CZ.NIC, z.s.p.o.', 'KnotDNS',
'High-performance authoritative DNS server implementation',
'Miscellaneous'),
]
......
Welcome to Knot DNS's documentation!
====================================
Contents:
.. toctree::
:maxdepth: 2
introduction
requirements
installation
configuration
running
troubleshooting
reference
migration
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
@node Statement Index, Knot DNS Configuration Reference, Troubleshooting, Top
@unnumbered Statement Index
@printindex st
......@@ -52,7 +52,7 @@ data synchronization library provides read-side access which scales
linearly with the number of cores. It does so by allowing multiple
copies of a given data structure to live at the same time, and by
monitoring the data structure accesses to detect grace periods after
which memory reclamation is possible. `Userspace RSU <http://lttng.org/urcu>`
which memory reclamation is possible. `Userspace RSU <http://lttng.org/urcu>`_
Binary packages for Debian can be found under ``liburcu1`` for the
library and ``liburcu-dev`` for development files.
......@@ -68,8 +68,8 @@ OpenBSD, NetBSD and OS X platforms are supported from version 0.7.0.
Installation from the sources
=============================
You can find the source files for the latest release on `www.knot-dns.cz <https://www.knot-dns.cz>`.
Alternatively, you can fetch the sources from git repository `<git://git.nic.cz/knot-dns.git>`.
You can find the source files for the latest release on `www.knot-dns.cz <https://www.knot-dns.cz>`_.
Alternatively, you can fetch the sources from git repository `<git://git.nic.cz/knot-dns.git>`_.
After unpacking the sources, the compilation and installation is a
quite straightforward process using autotools.
......@@ -183,7 +183,7 @@ option to upgrade to last stable version of the Knot DNS or to install
it on older versions of Ubuntu Linux.
We typically provide packages for all supported versions of Ubuntu
Linux including 5 year support for `LTS <https://wiki.ubuntu.com/LTS>`
Linux including 5 year support for `LTS <https://wiki.ubuntu.com/LTS>`_
versions of Ubuntu Linux. At the time of writing this manual this
includes Ubuntu 10.04 LTS, 11.04, 11.10 and 12.04 LTS.
......
......@@ -36,18 +36,25 @@ Server features:
* IPv4 / IPv6 support
* Semantic checks of zones
For more info and downloads see `www.knot-dns.cz <https://www.knot-dns.cz>`.
For more info and downloads see `www.knot-dns.cz <https://www.knot-dns.cz>`_.
Git repository: `git://git.nic.cz/knot-dns.git`
Git repository: `git://git.nic.cz/knot-dns.git <git://git.nic.cz/knot-dns.git>`_
Git repository browser: `gitlab.labs.nic.cz/knot/tree/master <https://gitlab.labs.nic.cz/knot/tree/master>`
Git repository browser: `gitlab.labs.nic.cz/knot/tree/master <https://gitlab.labs.nic.cz/knot/tree/master>`_
Knot DNS issue tracker: `gitlab.labs.nic.cz/knot/issues <https://gitlab.labs.nic.cz/knot/issues>`
Knot DNS issue tracker: `gitlab.labs.nic.cz/knot/issues <https://gitlab.labs.nic.cz/knot/issues>`_
Knot DNS users mailing list: `knot-dns-users@lists.nic.cz <mailto:knot-dns-users@@lists.nic.cz>`
Knot DNS users mailing list: `knot-dns-users@lists.nic.cz <mailto:knot-dns-users@@lists.nic.cz>`_
Scope of this document
----------------------
This document covers the basic information on installing, configuring
and troubleshooting the Knot DNS server.
License
-------
Knot DNS is licensed under `GNU General Public License <https://www.gnu.org/copyleft/gpl.html>`_
version 3 or (at your option) any later version. The full text of the license
is available in the ``COPYING`` file distributed with the source codes.
Welcome to Knot DNS's documentation!
====================================
This manual is for Knot DNS (version @VERSION@, @RELEASE_DATE@),
which is a high-performance authoritative-only DNS server.::
Copyright @copyright{} 2012 CZ.NIC, z.s.p.o.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Contents:
.. toctree::
:maxdepth: 2
introduction
requirements
installation
configuration
running
troubleshooting
reference
migration
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
......@@ -52,7 +52,7 @@ identity
Identity of the server returned in a response for the query for TXT
record ``id.server.`` or ``hostname.bind.`` in the CHAOS class (see
`RFC\ 4892 <http://tools.ietf.org/html/rfc4892>`).
`RFC\ 4892 <http://tools.ietf.org/html/rfc4892>`_).
If not specified or empty, the server returns REFUSED status code. If
a boolean value of ``on`` is used, FQDN hostname is used as a default.
......@@ -71,7 +71,7 @@ version
Version of the server software returned in a response for the query
for TXT record ``version.server.`` or ``version.bind.`` in the CHAOS
class (see `RFC\ 4892 <http://tools.ietf.org/html/rfc4892>`).
class (see `RFC\ 4892 <http://tools.ietf.org/html/rfc4892>`_).
Option allows a boolean value ``on|off``, if ``on``, automatic version
string is set as a default. If not specified or empty, the server
......@@ -89,7 +89,7 @@ returns REFUSED status code.
nsid
^^^^
DNS Name Server Identifier (see `RFC\ 5001 <http://tools.ietf.org/html/rfc5001>`).
DNS Name Server Identifier (see `RFC\ 5001 <http://tools.ietf.org/html/rfc5001>`_).
Use a string format "text" or a hexstring (e.g. 0x01ab00) If a
boolean value of ``on`` is used, FQDN hostname is used as a default.
......@@ -929,7 +929,7 @@ update, no change is made.
careful with transition to unix time. It may happen that the new
serial will be 'lower' than the old one. If this is the case, the
transition should be done by hand (see `RFC\ 1982
<https://tools.ietf.org/html/rfc1982>`).
<https://tools.ietf.org/html/rfc1982>`_).
Default value: ``increment``
......
......@@ -14,9 +14,9 @@ Submitting a bugreport
If you are unable to solve the problem by yourselves, you can submit a
bugreport to the Knot DNS team. For security issues (e.g. crash) do
not use the public mailinglist. Instead, write to
`knot-dns@labs.nic.cz <mailto:knot-dns@@labs.nic.cz>`. All other bugs
`knot-dns@labs.nic.cz <mailto:knot-dns@@labs.nic.cz>`_. All other bugs
and questions may be directed to the Knot DNS users mailinglist
(`knot-dns-users@lists.nic.cz <mailto:knot-dns-users@lists.nic.cz>`).
(`knot-dns-users@lists.nic.cz <mailto:knot-dns-users@lists.nic.cz>`_).
The bugreport should contain at least:
......
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