commit 44f824b69eb84e6b2c4e7db579a3fc6ae05948fd
parent c1dc2dc975742c929a523c22d91f7d4f82787230
Author: Martin Schanzenbach <schanzen@gnunet.org>
Date: Fri, 8 Sep 2023 20:22:29 +0200
Add sphinx generation here to avoid copy
Diffstat:
7 files changed, 192 insertions(+), 1 deletion(-)
diff --git a/.buildbot/build.sh b/.buildbot/build.sh
@@ -0,0 +1,3 @@
+#!/bin/bash
+
+make
diff --git a/.buildbot/firefly-x86_64-amdepyc_deploy.sh b/.buildbot/firefly-x86_64-amdepyc_deploy.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+# Deploy rest api from buildbot
+
+chmod -R ag+rX _build
+rsync --exclude=".*" --exclude="Makefile" --exclude="conf.py" -a --delete ./_build/ handbook@firefly.gnunet.org:~/gana/_build/
diff --git a/Makefile b/Makefile
@@ -0,0 +1,59 @@
+# Minimal makefile for Sphinx documentation
+#
+
+REGISTRIES = dot-alt \
+ gnu-name-system-default-tlds \
+ gnu-name-system-record-flags \
+ gnu-name-system-record-types \
+ gnu-taler-db-events \
+ gnu-taler-error-codes \
+ gnu-taler-extensions \
+ gnu-taler-kyc-attributes \
+ gnunet-dht-block-types \
+ gnunet-error-codes \
+ gnunet-protocols \
+ gnunet-signatures \
+ http-status-codes \
+ payto-payment-target-types
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
+
+
+all: rsts html
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: all clean help texinfo info Makefile
+
+rsts:
+ for dir in $(REGISTRIES); do \
+ $(MAKE) -C $$dir; \
+ done
+
+html:
+ @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+texinfo:
+ @$(SPHINXBUILD) -M texinfo "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+info:
+ @$(SPHINXBUILD) -M info "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+ rm -rf $(BUILDDIR)
+ for dir in $(REGISTRIES); do \
+ $(MAKE) -C $$dir; \
+ done
+
+distclean: clean
+
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+#%: Makefile
+# @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/_static/css/custom.css b/_static/css/custom.css
@@ -0,0 +1,3 @@
+div.wy-side-nav-search {
+ background: transparent !important;
+}
diff --git a/conf.py b/conf.py
@@ -0,0 +1,119 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+import sys
+import os
+
+project = 'GANA'
+copyright = '2023, GNUnet Project'
+author = 'GNUnet Project'
+
+sys.path.append(os.path.abspath("_exts"))
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'httpdomain.httpdomain',
+ 'typescriptdomain',
+ 'sphinx.ext.todo',
+ #'sphinx_book_theme',
+ #'breathe'
+]
+
+#breathe_projects = {
+# "gnunet": "../gnunet/doc/doxygen/xml/",
+#}
+
+#breathe_default_project = "gnunet"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_book_theme'
+
+html_sidebars = {
+ "**": ["navbar-logo.html", "sbt-sidebar-nav.html", "search-field.html"]
+}
+
+html_theme_options = {
+ #'logo_only': True,
+ #'display_version': False,
+ #'prev_next_buttons_location': 'bottom',
+ #'style_external_links': False,
+ #'vcs_pageview_mode': '',
+ #'style_nav_header_background': 'transparent', # Possibly problematic with our CSP
+ # Toc options
+ #'collapse_navigation': True,
+ #'sticky_navigation': True,
+ #'navigation_depth': 4,
+ #'includehidden': True,
+ #'titles_only': False
+ #"navbar_start": ["navbar-logo"],
+ "header_links_before_dropdown": 8,
+ "article_header_start": ["breadcrumbs.html"],
+ #"navbar_center": ["navbar-nav"],
+ "navbar_end": [],
+ "navbar_persistent": [],
+}
+
+# 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']
+
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = [
+ 'css/custom.css',
+]
+
+html_logo = "images/gnunet-blue.png"
+
+# Display to-do items in docs
+todo_include_todos = True
+
+primary_domain = "c"
+
+highlight_language = "c"
+
+rst_prolog = f"""
+.. role:: c(code)
+ :language: c
+
+.. role:: bolditalic
+ :class: bolditalic
+"""
+
+rst_epilog = """
+"""
+
+
diff --git a/gnu-name-system-record-types/registry.rec b/gnu-name-system-record-types/registry.rec
@@ -34,7 +34,7 @@ References: https://lsd.gnunet.org/lsd0001
Number: 65539
Name: VPN
Comment: VPN resolution
-References: https://lsd.gnunet.org/lsd0001
+References:
Number: 65540
Name: GNS2DNS
diff --git a/gnunet-dht-block-types/.gitignore b/gnunet-dht-block-types/.gitignore
@@ -0,0 +1 @@
+gnu-name-system-record-types.h
