use :doc: instead of :ref:

NLnetLabs · Dec 21, 2021 · 09b81bb · 09b81bb
1 parent 52f70fe
commit 09b81bb
Show file tree

Hide file tree

Showing 23 changed files with 27 additions and 88 deletions.
diff --git a/source/developer/doxygen-docs.rst b/source/developer/doxygen-docs.rst
@@ -1,5 +1,3 @@
-.. _doc_doxygen:
-
 Source Code Docs
 ================
 

diff --git a/source/developer/libunbound-tutorial/async-lookup.rst b/source/developer/libunbound-tutorial/async-lookup.rst
@@ -1,11 +1,9 @@
-.. _doc_libunbound_async_lookup:
-
 Asynchronous Lookup
 ===================
 
 This example performs the name lookup in the background. The original program
 keeps running, while the name is resolved. It is a modification of the example
-program from the :ref:`doc_libunbound_resolve_name` section.
+program from the :doc:`resolve-a-name` section.
 
 .. code-block:: c
 

diff --git a/source/developer/libunbound-tutorial/dnssec-validate.rst b/source/developer/libunbound-tutorial/dnssec-validate.rst
@@ -1,11 +1,8 @@
-.. _doc_libunbound_dnssec_validate:
-
 DNSSEC Validate
 ===============
 
 This example program performs DNSSEC validation of a lookup. It is a
-modification of the example program from the :ref:`doc_libunbound_setup_context`
-section.
+modification of the example program from the :doc:`setup-context` section.
 
 .. code-block:: c
 

diff --git a/source/developer/libunbound-tutorial/examine-results.rst b/source/developer/libunbound-tutorial/examine-results.rst
@@ -1,12 +1,9 @@
-.. _doc_libunbound_examine_results:
-
 Examine the Results
 ===================
 
 In the third example, the results returned are examined in detail. In addition,
 the program is modified to accept an argument, the name to look up. It is a
-modification of the example program from the :ref:`doc_libunbound_setup_context`
-section.
+modification of the example program from the :doc:`setup-context` section.
 
 .. code-block:: c
 

diff --git a/source/developer/libunbound-tutorial/index.rst b/source/developer/libunbound-tutorial/index.rst
@@ -1,5 +1,3 @@
-.. _doc_libunbound:
-
 Unbound Library Tutorial
 ========================
 

diff --git a/source/developer/libunbound-tutorial/lookup-threads.rst b/source/developer/libunbound-tutorial/lookup-threads.rst
@@ -1,11 +1,9 @@
-.. _doc_libunbound_lookup_threads:
-
 Lookup from Threads
 ===================
 
 This example shows how to use libunbound from a threaded program. It is a
-modification of the example program from the :ref:`doc_libunbound_setup_context`
-section. It creates two threads and resolves from both threads.
+modification of the example program from the :doc:`setup-context` section. It
+creates two threads and resolves from both threads.
 
 This example uses ``pthreads``, and assumes that libunbound was compiled with
 threading enabled (which is the default, if ``pthreads`` can be found). To

diff --git a/source/developer/libunbound-tutorial/resolve-a-name.rst b/source/developer/libunbound-tutorial/resolve-a-name.rst
@@ -1,12 +1,10 @@
-.. _doc_libunbound_resolve_name:
-
 Resolve a Name
 ==============
 
 First, obtain `ldns <https://www.nlnetlabs.nl/projects/ldns/about/>`_ and
-:ref:`Unbound <doc_unbound_installation>`, compile and install them. To compile
-a program with its library use this command, assuming unbound was installed in
-``/usr/local``:
+:doc:`Unbound </getting-started/installation>`, compile and install them. To
+compile a program with its library use this command, assuming unbound was
+installed in ``/usr/local``:
 
 .. code-block:: bash
 

diff --git a/source/developer/libunbound-tutorial/setup-context.rst b/source/developer/libunbound-tutorial/setup-context.rst
@@ -1,11 +1,9 @@
-.. _doc_libunbound_setup_context:
-
 Setup the Context
 =================
 
 In the second example we set additional useful options on the context, to
 enhance performance and utility. It is a modification of the example program
-from the :ref:`doc_libunbound_resolve_name` section.
+from the :doc:`resolve-a-name` section.
 
 .. code-block:: c
 
@@ -66,8 +64,8 @@ Invocation of this program yields the following:
     $ example_2
     The address is 213.154.224.1
 
-As said, the code is a modification of the :ref:`first
-example<doc_libunbound_resolve_name>`. The context is set up, a single name is
+As said, the code is a modification of the :doc:`first
+example<resolve-a-name>`. The context is set up, a single name is
 looked up, and the results and context are freed. The difference is that local
 settings are applied.
 

diff --git a/source/developer/python-modules.rst b/source/developer/python-modules.rst
@@ -1,5 +1,3 @@
-.. _doc_pyunbound:
-
 Unbound for Python
 ==================
 

diff --git a/source/getting-started/configuration.rst b/source/getting-started/configuration.rst
@@ -1,7 +1,5 @@
-.. _doc_unbound_configuration:
-
 Configuration
--------------
+=============
 
 Unbound has a vast array of configuration options for advanced use cases, which can seem a little overwhelming at first. Luckily, all of the defaults are sensible and secure, so in a lot of environments you can run Unbound without changing any options. Below we will go through a basic, recommended config, but feel free to add and experiment with options as you need them.
 
@@ -49,7 +47,7 @@ By default Unbound assumes that a user named "unbound" exists, which you can add
 
 
 Set up Remote Control
-=====================
+---------------------
 
 A useful functionality to enable is the use of the :command:`unbound-control` command. This allows command makes starting, stopping, and reloading Unbound easier. To enable this functionality we need to add :option:`remote-control` to the config and enable it.
 
@@ -84,7 +82,7 @@ You can now control Unbound using the :command:`unbound-control` command. Note t
 
 
 Set up Trust Anchor (Enable DNSSEC)
-===================================
+-----------------------------------
 
 To enable `DNSSEC <https://www.sidn.nl/en/cybersecurity/dnssec-explained>`_, which we strongly recommend, we need to set up a trust anchor as it allows the verification of the integrity of the responses to the queries you send.
 

diff --git a/source/getting-started/installation.rst b/source/getting-started/installation.rst
@@ -1,7 +1,5 @@
-.. _doc_unbound_installation:
-
 Installation
-------------
+============
 
 To install your own copy of Unbound you have two options: Use the version provided by your package manager, or download the source and building it yourself.
 
@@ -10,14 +8,14 @@ Building and compiling Unbound yourself ensures that you have the latest version
 
 If you're a first-time user we recommend installing via a package manager.
 
-Installing with a package manager
-=================================
+Installing with a Package Manager
+---------------------------------
 
 Most package managers maintain a version of Unbound, although this version can be outdated if this package has not been updated recently. If you like to upgrade to the latest version, we recommend :ref:`compiling Unbound yourself<Building from source/Compiling>`.
 
 
 Ubuntu 20.04.1 LTS
-******************
+^^^^^^^^^^^^^^^^^^
 
 Installing Unbound with the built-in package manager should be as easy as:
 
@@ -29,7 +27,7 @@ Installing Unbound with the built-in package manager should be as easy as:
 This gives you a compiled and running version of Unbound ready to :ref:`be configured<doc_unbound_configuration>`.
 
 macOS Big Sur
-*************
+^^^^^^^^^^^^^
 
 In this tutorial we make use of the Brew package installer for MacOS. Install ``brew`` and, if you've never used ``brew`` before, give `their website <https://brew.sh/>`_ a read.
 
@@ -47,12 +45,12 @@ Then use brew to install Unbound.
 This gives you a compiled and running version of Unbound ready to :ref:`be configured<doc_unbound_configuration>`.
 
 Building from source/Compiling
-==============================
+------------------------------
 
 To compile Unbound on any system you need to have the ``openssl`` and ``expat`` libraries, and their header files. To include the header files we need to get the development version, usually called ``libssl-dev`` and ``libexpat1-dev`` respectively.
 
 Ubuntu 20.04.1 LTS
-******************
+^^^^^^^^^^^^^^^^^^
 
 First of all, we need our copy of the Unbound code, so we download the tarball of the latest version and untar it.
 
@@ -114,7 +112,7 @@ Please note that the default configuration file is located at ``/usr/local/etc/u
 .. Ref to testing
 
 macOS Big Sur
-*************
+^^^^^^^^^^^^^
 
 In this tutorial we make use of the :command:`brew` package installer for MacOS. Install :command:`brew` and give `their website <https://brew.sh/>`_ a read if you've never used brew before.
 
@@ -195,7 +193,7 @@ We now have fully compiled and installed version of Unbound, and can :ref:`conti
 .. Ref to testing
 
 Testing
-=======
+-------
 
 A simple test to determine if the installation was successful is to invoke the :command:`unbound` command with the :option:`-V` option, which is the "version" option. This shows the version and build options used, as well as proving that the install was successful.
 
@@ -207,4 +205,4 @@ If all the previous steps were successful we can continue to configuring our Unb
 
 Another handy trick you can use during testing is to run Unbound in the foreground using the :option:`-d` option and increase the verbosity level using the :option:`-vvv` option. This allows you to see steps Unbound takes and also where it fails.
 
-Now that Unbound is installed we can :ref:`continue to configuring it<doc_unbound_configuration>`.
+Now that Unbound is installed we can :doc:`continue to configuring it<configuration>`.
diff --git a/source/index.rst b/source/index.rst
@@ -1,13 +1,11 @@
-.. _doc_index:
-
 Unbound by NLnet Labs
 =====================
 
 Unbound is a validating, recursive, caching DNS resolver. It is designed to be
 fast and lean and incorporates modern features based on open standards.
 
 .. Note::  Do you love to write and know your way around DNS and Unbound? 
-           :ref:`Help us expand this documentation <doc_todo>` and we'll
+           :doc:`Help us expand this documentation <reference/todo>` and we'll
            compensate you for your time. Contact us at docs@nlnetlabs.nl or find
            us on `Twitter <https://twitter.com/nlnetlabs>`_.
 

diff --git a/source/manpages/libunbound.rst b/source/manpages/libunbound.rst
@@ -1,5 +1,3 @@
-.. _doc_libunbound_manpage:
-
 libunbound(3)
 =============
 

diff --git a/source/manpages/unbound-anchor.rst b/source/manpages/unbound-anchor.rst
@@ -1,5 +1,3 @@
-.. _doc_unbound_anchor_manpage:
-
 unbound-anchor(8)
 =================
 

diff --git a/source/manpages/unbound-checkconf.rst b/source/manpages/unbound-checkconf.rst
@@ -1,5 +1,3 @@
-.. _doc_unbound_checkconf_manpage:
-
 unbound-checkconf(8)
 ====================
 

diff --git a/source/manpages/unbound-control.rst b/source/manpages/unbound-control.rst
@@ -1,5 +1,3 @@
-.. _doc_unbound_control_manpage:
-
 unbound-control(8)
 ==================
 

diff --git a/source/manpages/unbound-host.rst b/source/manpages/unbound-host.rst
@@ -1,5 +1,3 @@
-.. _doc_unbound_host_manpage:
-
 unbound-host(1)
 ===============
 

diff --git a/source/manpages/unbound.conf.rst b/source/manpages/unbound.conf.rst
@@ -1,5 +1,3 @@
-.. _doc_unbound_conf_manpage:
-
 unbound.conf(5)
 ===============
 
@@ -756,6 +754,7 @@ logfile: *<filename>*
     logfile is appended to, in the following format: 
 
     .. code-block:: text
+        
         [seconds since 1970] unbound[pid:tid]: type: message. 
         
     If this option is given, the use-syslog is option is set to "no". The
@@ -1135,7 +1134,7 @@ val-bogus-ttl: *<number>*
     The time to live for bogus data. This is data that has failed validation;
     due to invalid signatures or other checks. The TTL from that data cannot be
     trusted, and this value is used instead. The value is in seconds, default
-    60. The time interval prevents repeated revalidation of bogus data.
+    1.  The time interval prevents repeated revalidation of bogus data.
 
 val-clean-additional: *<yes or no>*
     Instruct the validator to remove data from the additional section of secure

diff --git a/source/manpages/unbound.rst b/source/manpages/unbound.rst
@@ -1,5 +1,3 @@
-.. _doc_unbound_manpage:
-
 unbound(8)
 ==========
 

diff --git a/source/reference/history/index.rst b/source/reference/history/index.rst
@@ -1,5 +1,3 @@
-.. _doc_history:
-
 History
 =======
 

diff --git a/source/reference/rfc-compliance.rst b/source/reference/rfc-compliance.rst
@@ -1,5 +1,3 @@
-.. _doc_rfc:
-
 RFC Compliance
 ==============
 

diff --git a/source/reference/todo.rst b/source/reference/todo.rst
@@ -1,5 +1,3 @@
-.. _doc_todo:
-
 Docs To-Do List
 ===============
 

diff --git a/source/topics/privacy/index.rst b/source/topics/privacy/index.rst