Skip to content

Commit 6220ff9

Browse files
PesaPesa
committed
docs: change sphinx HTML theme to furo
Change-Id: I53e30cd5d9686602910e16ce17f598246eadef96
1 parent ed30757 commit 6220ff9

14 files changed

Lines changed: 69 additions & 160 deletions

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1+
<div align="center">
2+
3+
[<img alt height="65" src="docs/ndn-logo.svg"/>](https://named-data.net/)
4+
15
# NLSR: Named Data Link State Routing Protocol
26

7+
</div>
8+
39
![Latest version](https://img.shields.io/github/v/tag/named-data/NLSR?label=Latest%20version)
410
![Language](https://img.shields.io/badge/C%2B%2B-17-blue)
511
[![CI](https://github.com/named-data/NLSR/actions/workflows/ci.yml/badge.svg)](https://github.com/named-data/NLSR/actions/workflows/ci.yml)

‎docs/GETTING-STARTED.rst‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
Getting Started with NLSR
22
=========================
33

4-
.. toctree::
5-
..
6-
74
Obtaining the Source Code
85
-------------------------
96

10-
- `GitHub NLSR repository <https://github.com/named-data/NLSR>`__
7+
See `GitHub NLSR repository <https://github.com/named-data/NLSR>`__.
118

129
Installation
1310
------------
1411

15-
:doc:`INSTALL`
12+
See :doc:`INSTALL`.
1613

1714
Important Notes About Configuration
1815
-----------------------------------

‎docs/INSTALL.rst‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
Installation Instructions
22
=========================
33

4-
.. toctree::
5-
..
6-
74
Prerequisites
85
-------------
96

@@ -15,13 +12,13 @@ Prerequisites
1512
- PSync library [optional but recommended, enabled by default]
1613

1714
Download the PSync library and build it according to the instructions available at
18-
https://github.com/named-data/PSync#build
15+
https://github.com/named-data/PSync#installation
1916

2017
- ChronoSync library [optional, deprecated]
2118

2219
For testing purposes, NLSR can be optionally built with ChronoSync support. Download
2320
the ChronoSync library and build it according to the instructions available at
24-
https://github.com/named-data/ChronoSync#build
21+
https://github.com/named-data/ChronoSync#installation
2522

2623
- SVS library [optional]
2724

‎docs/ROUTER-CONFIG.rst‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
Router Configuration
22
====================
33

4-
.. toctree::
5-
..
6-
74
Example network and sample configuration
85
----------------------------------------
96

@@ -43,7 +40,7 @@ Step 1. Ensuring nfd is running
4340

4441
Type the following in the terminal:
4542

46-
::
43+
.. code-block:: sh
4744
4845
nfd-status
4946
@@ -268,9 +265,9 @@ Step 4: Running NLSR on /ndn/memphis.edu/router1
268265

269266
Assuming the configuration file is saved as ``nlsr.conf``, type the following to run nlsr:
270267

271-
::
268+
.. code-block:: sh
272269
273-
$ nlsr -f nlsr.conf
270+
nlsr -f nlsr.conf
274271
275272
NLSR will look for nlsr.conf in the current directory. If nlsr.conf is not in the current
276273
directory, please provide the absolute path with the file name as the value. If

‎docs/SECURITY-CONFIG.rst‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
Security Configuration
22
=======================
33

4-
.. toctree::
5-
..
6-
74
The trust model of NLSR is semi-hierarchical. An example certificate signing hierarchy is:
85

96
::

‎docs/conf.py‎

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
# -- Project information -----------------------------------------------------
1010
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
1111

12-
project = 'Named Data Link State Routing Protocol (NLSR)'
13-
copyright = 'Copyright © 2014-2025 Named Data Networking Project.'
12+
project = 'NLSR'
13+
copyright = '2014-2026, Named Data Networking Project'
1414
author = 'Named Data Networking Project'
1515

1616
# The short X.Y version.
@@ -29,7 +29,7 @@
2929
# -- General configuration ---------------------------------------------------
3030
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
3131

32-
needs_sphinx = '4.0'
32+
needs_sphinx = '7.0'
3333
extensions = [
3434
'sphinx.ext.extlinks',
3535
'sphinx.ext.todo',
@@ -47,26 +47,40 @@ def addExtensionIfExists(extension: str):
4747

4848
addExtensionIfExists('sphinxcontrib.doxylink')
4949

50-
templates_path = ['_templates']
51-
exclude_patterns = ['Thumbs.db', '.DS_Store']
50+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
5251

52+
# Disable syntax highlighting of code blocks by default.
53+
highlight_language = 'none'
5354

54-
# -- Options for HTML output -------------------------------------------------
55-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
55+
# Generate warnings for all missing references.
56+
nitpicky = True
5657

57-
html_theme = 'named_data_theme'
58-
html_theme_path = ['.']
5958

60-
# Add any paths that contain custom static files (such as style sheets) here,
61-
# relative to this directory. They are copied after the builtin static files,
62-
# so a file named "default.css" will overwrite the builtin "default.css".
63-
html_static_path = ['_static']
59+
# -- Options for HTML output -------------------------------------------------
60+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
6461

62+
html_theme = 'furo'
63+
html_logo = 'ndn-logo.svg'
6564
html_copy_source = False
6665
html_show_sourcelink = False
6766

68-
# Disable syntax highlighting of code blocks by default.
69-
highlight_language = 'none'
67+
html_theme_options = {
68+
'light_css_variables': {
69+
'color-brand-primary': '#bc4010',
70+
'color-brand-content': '#c85000',
71+
'color-brand-visited': '#c85000',
72+
},
73+
'dark_css_variables': {
74+
'color-brand-primary': '#fd861a',
75+
'color-brand-content': '#f87e00',
76+
'color-brand-visited': '#f87e00',
77+
},
78+
'source_repository': 'https://github.com/named-data/NLSR',
79+
'source_branch': 'master',
80+
}
81+
82+
pygments_style = 'tango'
83+
pygments_dark_style = 'material'
7084

7185

7286
# -- Options for manual page output ------------------------------------------

‎docs/doxygen.conf.in‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "NLSR: Named Data Link State Routing Protocol"
35+
PROJECT_NAME = NLSR
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version

‎docs/index.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ NLSR: Named Data Link State Routing Protocol
33

44
.. toctree::
55
:hidden:
6-
:maxdepth: 2
76

87
GETTING-STARTED
98
INSTALL

‎docs/manpages/nlsr.rst‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,23 @@ Usage
88

99
nlsr [options]
1010

11-
1211
Description
1312
-----------
1413

1514
``nlsr`` is a process that implements routing protocol in NDN to populate NDN's Routing
1615
Information Base.
1716

18-
Options:
19-
--------
17+
Options
18+
-------
2019

2120
``-f <FILE>``
22-
Specify configuration file name (default: ``./nlsr.conf``)
21+
Specify configuration file name (default: ``./nlsr.conf``).
2322

2423
``-V``
25-
Display version information
24+
Display version information.
2625

2726
``-h``
28-
Display this help message
27+
Display help message.
2928

3029
Examples
3130
--------

‎docs/manpages/nlsrc.rst‎

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ Usage
77
::
88

99
nlsrc [-h | -V]
10-
nlsrc [-R <router prefix> [-c <nlsr.conf path> | -k]] COMMAND [<Command Options>]
11-
10+
nlsrc [-R <router prefix> [-c <nlsr.conf path> | -k]] COMMAND [<command options>]
1211

1312
Description
1413
-----------
@@ -39,39 +38,39 @@ Options
3938
``COMMAND``
4039

4140
``lsdb``
42-
Retrieve LSDB status information
41+
Retrieve LSDB status information.
4342

4443
``routing``
45-
Retrieve routing table status information
44+
Retrieve routing table status information.
4645

4746
``status``
48-
Retrieve LSDB status and routing table status information
47+
Retrieve LSDB status and routing table status information.
4948

5049
``advertise``
51-
Add a Name prefix to be advertised by NLSR
50+
Add a Name prefix to be advertised by NLSR.
5251

5352
``advertise <name>``
5453

5554
``name``
56-
The Name prefix to be advertised
55+
The Name prefix to be advertised.
5756

5857
``advertise <name> save``
5958

6059
``save``
61-
Advertise a prefix and also save it to the nlsr.conf file residing in the state-dir for the next start of NLSR that operator may copy and use for the next start of NLSR
60+
Advertise a prefix and also save it to the nlsr.conf file residing in the state-dir for the next start of NLSR that operator may copy and use for the next start of NLSR.
6261

6362
``withdraw``
64-
Remove a Name prefix advertised through NLSR
63+
Remove a Name prefix advertised through NLSR.
6564

6665
``withdraw <name>``
6766

6867
``name``
69-
The Name prefix to be withdrawn
68+
The Name prefix to be withdrawn.
7069

7170
``withdraw <name> delete``
7271

7372
``delete``
74-
Withdraw a prefix and also delete it from the nlsr.conf file residing in the state-dir
73+
Withdraw a prefix and also delete it from the nlsr.conf file residing in the state-dir.
7574

7675
Notes
7776
-----
@@ -82,16 +81,19 @@ If default identity is not set as operator, the user will be presented with the
8281
error message: "Name prefix update error (code: 403)". To remedy this
8382
issue, use the command ``ndnsec set-default``. Example::
8483

85-
ndnsec set-default /ndn/a-site/%C1.Operator/op
84+
ndnsec set-default /ndn/a-site/%C1.Operator/op
8685

8786
Support for adding prefix costs is currently only implemented via readvertisement;
8887
this functionality will be added in a future release.
8988

9089
Exit Status
9190
-----------
9291

93-
nlsrc exits with one of the following values::
92+
0
93+
Success.
94+
95+
1
96+
Generic error.
9497

95-
0 nlsrc exited successfully
96-
1 generic error
97-
2 bad command line
98+
2
99+
Malformed command line.

0 commit comments

Comments
 (0)