commit 8cd67a370898b357b6f7531c76e09054a67628ff
parent 5262f14c0bfed142e066850bfeddaebc5c7d2540
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date: Sat, 1 Oct 2022 14:08:35 +0900
Improve man page generation slightly
Diffstat:
| M | conf.py | | | 26 | ++++++++++++++++++++++++++ |
| M | gana/index.rst | | | 50 | +------------------------------------------------- |
2 files changed, 27 insertions(+), 49 deletions(-)
diff --git a/conf.py b/conf.py
@@ -70,6 +70,32 @@ html_theme_options = {
'titles_only': False
}
+man_make_section_directory = False
+man_pages = [
+ ('about', 'gnunet', 'About GNUnet', '', '1'),
+ ('installing', 'gnunet', 'Installing GNUnet', '', '2'),
+ ('users/start', 'gnunet', 'Starting and stopping', '', '3'),
+ ('users/gns', 'gnunet', 'The GNU Name System', '', '4'),
+ ('users/reclaim', 'gnunet', 're:claimID', '', '5'),
+ ('users/fs', 'gnunet', 'GNUnet File-Sharing', '', '6'),
+ ('users/vpn', 'gnunet', 'GNUnet VPN', '', '7'),
+ ('users/messenger', 'gnunet', 'GNUnet Messenger', '', '8'),
+ ('users/configuration', 'gnunet', 'GNUnet advanced configuration', '', '9'),
+ ('developers/contributing', 'gnunet-dev', 'Contributing', '', '1'),
+ ('developers/style', 'gnunet-dev', 'Style and workflow', '', '2'),
+ ('developers/util/index', 'gnunet-dev', 'libgnunetutil', '', '3'),
+ ('developers/subsystems/index', 'gnunet-dev', 'Architecture', '', '4'),
+ ('developers/rest/index', 'gnunet-dev', 'REST API', '', '5'),
+ ('developers/tutorial', 'gnunet-dev', 'GNUnet Developer Tutorial', '', '6'),
+ ('livingstandards', 'lsd', 'Living Standards', '', '1'),
+ ('gana/intro', 'gana', 'GNUnet Assigned Numbers Authority (GANA)', '', '1'),
+ ('gana/gnu_name_system_record_types', 'gana', 'Registry for GNU Name System record types', '', '2'),
+ ('gana/tlds', 'gana', 'Registry for GNU Name System default Top-Level-Domains', '', '3'),
+ ('gana/gnunet_dht_block_types', 'gana', 'Registry for DHT block types', '', '4'),
+ ('gana/gnunet_signatures', 'gana', 'Registry for Signature purposes', '', '5'),
+
+]
+
# 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".
diff --git a/gana/index.rst b/gana/index.rst
@@ -1,55 +1,7 @@
GANA
====
-The GNUnet Assigned Numbers Authority (GANA) contains various registries
-we maintain, for GNUnet other projects that need names and numbers for
-use in network protocols. If you need to open a new registry, please
-feel free to contact us at gana@gnunet.org.
-
-The registries can be found here: https://git.gnunet.org/gana.git
-
-History
--------
-
-Barry Leiba wrote on April 4th 2020 that “Neither IANA nor participants
-in the IETF will have any necessary expertise to evaluate registration
-requests in the sort of registry described, and no one will be well
-served by the creation of such a registry at IANA. It would be far
-better to have a registration process be described in this document
-involving experts from the industry as reviewers and maintenance of the
-registrations by an industry organization, rather than by IANA.”
-
-So here we are. As IETF/IANA “lack the necessary expertise to operate a
-registry” for names and numbers used in network protocols, the GNUnet
-project is happy to step up.
-
-License
--------
-
-The GANA database is licensed under the GPL. See ``COPYING`` in the Git
-repository.
-
-Design
-------
-
-Each registry must have a unique name and all associated information
-lives in a directory under that unique name in the Git repository.
-
-Each registry must include at least the following files:
-
-- ``README[.*]``: document describing the purpose of the registry in
- English
-- ``POLICY[.*]``: registration policy, explaining required fields and
- the procedure for adding, updating and deleting entries
-- ``registry.rec``: GNU recutils data file with all of the current
- entries in the registry
-- ``Makefile``: GNU make makefile with a ``make check`` target to run
- the validation logic. Ideally, the registry.rec should be written
- such that the ``check`` target is simply invoking
- ``recfix --check registry.rec``. Additional targets to convert
- ``data.rec`` to various formats may be defined. In particular, see
- ``format.sh`` in the root directory of the Git repository (try
- ``--help``).
+.. include:: intro.rst
Registries
----------
