Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve build from source section #402

Merged
merged 6 commits into from
Oct 28, 2024
Merged

Improve build from source section #402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
abc02f6
Add sphinx_substitution_extensions add-on for version
melroy89 Oct 28, 2024
2826764
Use version substitution in documentation
melroy89 Oct 28, 2024
cc8d3ca
Remove whitespaces
melroy89 Oct 28, 2024
fa83e00
Use more threads in the make process
melroy89 Oct 28, 2024
115543c
Add Sphinx-Substitution-Extensions to requirements
melroy89 Oct 28, 2024
4ac8649
Fix pip names
melroy89 Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/manual/conf.py.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ extensions = [
'notfound.extension',
'sphinxcontrib.jquery',
'sphinx_rtd_theme',
'sphinx_substitution_extensions',
]

intersphinx_mapping = {
Expand Down
13 changes: 7 additions & 6 deletions doc/manual/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,19 @@ configured<configuration>`.
Building from source
====================

Ubuntu 20.04 LTS
****************
Ubuntu
******

First of all, we need our copy of the NSD code. `On our website
<https://nlnetlabs.nl/projects/nsd/about/>`_ you can find the latest version
and the changelog. In this example we'll use version 4.10.1. Please note
and the changelog. In this example we'll use version |version|. Please note
that this may not be the latest version currently.

.. code-block:: bash
:substitutions:

wget https://nlnetlabs.nl/downloads/nsd/nsd-4.10.1.tar.gz
tar xzf nsd-4.10.1.tar.gz
wget https://nlnetlabs.nl/downloads/nsd/nsd-|version|.tar.gz
tar xzf nsd-|version|.tar.gz


We'll need some tools, such as a compiler and the :command:`make` program.
Expand Down Expand Up @@ -98,7 +99,7 @@ NSD using :command:`make`; compilation might take a while.

.. code-block:: bash

make
make -j4

After successfully compiling, we can install NSD to make it available for
the machine.
Expand Down
3 changes: 2 additions & 1 deletion doc/manual/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
sphinx==5.0.2
Sphinx==5.0.2
sphinx-version-warning==1.1.2
sphinx-tabs==3.4.4
sphinx-copybutton==0.5.2
sphinx-rtd-theme
sphinx-notfound-page
requests
sphinx-substitution-extensions