diff options
author | Martin Schanzenbach <schanzen@gnunet.org> | 2023-09-08 20:22:29 +0200 |
---|---|---|
committer | Martin Schanzenbach <schanzen@gnunet.org> | 2023-09-08 20:22:35 +0200 |
commit | 44f824b69eb84e6b2c4e7db579a3fc6ae05948fd (patch) | |
tree | 1e376bddd159b1c2857e2b72906f1982310c51cd | |
parent | c1dc2dc975742c929a523c22d91f7d4f82787230 (diff) | |
download | gana-44f824b69eb84e6b2c4e7db579a3fc6ae05948fd.tar.gz gana-44f824b69eb84e6b2c4e7db579a3fc6ae05948fd.zip |
Add sphinx generation here to avoid copy
-rwxr-xr-x | .buildbot/build.sh | 3 | ||||
-rwxr-xr-x | .buildbot/firefly-x86_64-amdepyc_deploy.sh | 6 | ||||
-rw-r--r-- | Makefile | 59 | ||||
-rw-r--r-- | _static/css/custom.css | 3 | ||||
-rw-r--r-- | conf.py | 119 | ||||
-rw-r--r-- | gnu-name-system-record-types/registry.rec | 2 | ||||
-rw-r--r-- | gnunet-dht-block-types/.gitignore | 1 |
7 files changed, 192 insertions, 1 deletions
diff --git a/.buildbot/build.sh b/.buildbot/build.sh new file mode 100755 index 0000000..2aad486 --- /dev/null +++ b/.buildbot/build.sh | |||
@@ -0,0 +1,3 @@ | |||
1 | #!/bin/bash | ||
2 | |||
3 | make | ||
diff --git a/.buildbot/firefly-x86_64-amdepyc_deploy.sh b/.buildbot/firefly-x86_64-amdepyc_deploy.sh new file mode 100755 index 0000000..a7f8ea5 --- /dev/null +++ b/.buildbot/firefly-x86_64-amdepyc_deploy.sh | |||
@@ -0,0 +1,6 @@ | |||
1 | #!/bin/bash | ||
2 | |||
3 | # Deploy rest api from buildbot | ||
4 | |||
5 | chmod -R ag+rX _build | ||
6 | rsync --exclude=".*" --exclude="Makefile" --exclude="conf.py" -a --delete ./_build/ handbook@firefly.gnunet.org:~/gana/_build/ | ||
diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e515dfc --- /dev/null +++ b/Makefile | |||
@@ -0,0 +1,59 @@ | |||
1 | # Minimal makefile for Sphinx documentation | ||
2 | # | ||
3 | |||
4 | REGISTRIES = dot-alt \ | ||
5 | gnu-name-system-default-tlds \ | ||
6 | gnu-name-system-record-flags \ | ||
7 | gnu-name-system-record-types \ | ||
8 | gnu-taler-db-events \ | ||
9 | gnu-taler-error-codes \ | ||
10 | gnu-taler-extensions \ | ||
11 | gnu-taler-kyc-attributes \ | ||
12 | gnunet-dht-block-types \ | ||
13 | gnunet-error-codes \ | ||
14 | gnunet-protocols \ | ||
15 | gnunet-signatures \ | ||
16 | http-status-codes \ | ||
17 | payto-payment-target-types | ||
18 | |||
19 | # You can set these variables from the command line, and also | ||
20 | # from the environment for the first two. | ||
21 | SPHINXOPTS ?= | ||
22 | SPHINXBUILD ?= sphinx-build | ||
23 | SOURCEDIR = . | ||
24 | BUILDDIR = _build | ||
25 | |||
26 | |||
27 | all: rsts html | ||
28 | |||
29 | # Put it first so that "make" without argument is like "make help". | ||
30 | help: | ||
31 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
32 | |||
33 | .PHONY: all clean help texinfo info Makefile | ||
34 | |||
35 | rsts: | ||
36 | for dir in $(REGISTRIES); do \ | ||
37 | $(MAKE) -C $$dir; \ | ||
38 | done | ||
39 | |||
40 | html: | ||
41 | @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
42 | |||
43 | texinfo: | ||
44 | @$(SPHINXBUILD) -M texinfo "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
45 | |||
46 | info: | ||
47 | @$(SPHINXBUILD) -M info "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
48 | |||
49 | clean: | ||
50 | rm -rf $(BUILDDIR) | ||
51 | for dir in $(REGISTRIES); do \ | ||
52 | $(MAKE) -C $$dir; \ | ||
53 | done | ||
54 | |||
55 | distclean: clean | ||
56 | |||
57 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
58 | #%: Makefile | ||
59 | # @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
diff --git a/_static/css/custom.css b/_static/css/custom.css new file mode 100644 index 0000000..05db767 --- /dev/null +++ b/_static/css/custom.css | |||
@@ -0,0 +1,3 @@ | |||
1 | div.wy-side-nav-search { | ||
2 | background: transparent !important; | ||
3 | } | ||
@@ -0,0 +1,119 @@ | |||
1 | # Configuration file for the Sphinx documentation builder. | ||
2 | # | ||
3 | # This file only contains a selection of the most common options. For a full | ||
4 | # list see the documentation: | ||
5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
6 | |||
7 | # -- Path setup -------------------------------------------------------------- | ||
8 | |||
9 | # If extensions (or modules to document with autodoc) are in another directory, | ||
10 | # add these directories to sys.path here. If the directory is relative to the | ||
11 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
12 | # | ||
13 | # import os | ||
14 | # import sys | ||
15 | # sys.path.insert(0, os.path.abspath('.')) | ||
16 | |||
17 | |||
18 | # -- Project information ----------------------------------------------------- | ||
19 | import sys | ||
20 | import os | ||
21 | |||
22 | project = 'GANA' | ||
23 | copyright = '2023, GNUnet Project' | ||
24 | author = 'GNUnet Project' | ||
25 | |||
26 | sys.path.append(os.path.abspath("_exts")) | ||
27 | |||
28 | # -- General configuration --------------------------------------------------- | ||
29 | |||
30 | # Add any Sphinx extension module names here, as strings. They can be | ||
31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
32 | # ones. | ||
33 | extensions = [ | ||
34 | 'httpdomain.httpdomain', | ||
35 | 'typescriptdomain', | ||
36 | 'sphinx.ext.todo', | ||
37 | #'sphinx_book_theme', | ||
38 | #'breathe' | ||
39 | ] | ||
40 | |||
41 | #breathe_projects = { | ||
42 | # "gnunet": "../gnunet/doc/doxygen/xml/", | ||
43 | #} | ||
44 | |||
45 | #breathe_default_project = "gnunet" | ||
46 | |||
47 | # Add any paths that contain templates here, relative to this directory. | ||
48 | templates_path = ['_templates'] | ||
49 | |||
50 | # List of patterns, relative to source directory, that match files and | ||
51 | # directories to ignore when looking for source files. | ||
52 | # This pattern also affects html_static_path and html_extra_path. | ||
53 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
54 | |||
55 | |||
56 | # -- Options for HTML output ------------------------------------------------- | ||
57 | |||
58 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
59 | # a list of builtin themes. | ||
60 | # | ||
61 | html_theme = 'sphinx_book_theme' | ||
62 | |||
63 | html_sidebars = { | ||
64 | "**": ["navbar-logo.html", "sbt-sidebar-nav.html", "search-field.html"] | ||
65 | } | ||
66 | |||
67 | html_theme_options = { | ||
68 | #'logo_only': True, | ||
69 | #'display_version': False, | ||
70 | #'prev_next_buttons_location': 'bottom', | ||
71 | #'style_external_links': False, | ||
72 | #'vcs_pageview_mode': '', | ||
73 | #'style_nav_header_background': 'transparent', # Possibly problematic with our CSP | ||
74 | # Toc options | ||
75 | #'collapse_navigation': True, | ||
76 | #'sticky_navigation': True, | ||
77 | #'navigation_depth': 4, | ||
78 | #'includehidden': True, | ||
79 | #'titles_only': False | ||
80 | #"navbar_start": ["navbar-logo"], | ||
81 | "header_links_before_dropdown": 8, | ||
82 | "article_header_start": ["breadcrumbs.html"], | ||
83 | #"navbar_center": ["navbar-nav"], | ||
84 | "navbar_end": [], | ||
85 | "navbar_persistent": [], | ||
86 | } | ||
87 | |||
88 | # Add any paths that contain custom static files (such as style sheets) here, | ||
89 | # relative to this directory. They are copied after the builtin static files, | ||
90 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
91 | html_static_path = ['_static'] | ||
92 | |||
93 | # These paths are either relative to html_static_path | ||
94 | # or fully qualified paths (eg. https://...) | ||
95 | html_css_files = [ | ||
96 | 'css/custom.css', | ||
97 | ] | ||
98 | |||
99 | html_logo = "images/gnunet-blue.png" | ||
100 | |||
101 | # Display to-do items in docs | ||
102 | todo_include_todos = True | ||
103 | |||
104 | primary_domain = "c" | ||
105 | |||
106 | highlight_language = "c" | ||
107 | |||
108 | rst_prolog = f""" | ||
109 | .. role:: c(code) | ||
110 | :language: c | ||
111 | |||
112 | .. role:: bolditalic | ||
113 | :class: bolditalic | ||
114 | """ | ||
115 | |||
116 | rst_epilog = """ | ||
117 | """ | ||
118 | |||
119 | |||
diff --git a/gnu-name-system-record-types/registry.rec b/gnu-name-system-record-types/registry.rec index 4433782..9e36eef 100644 --- 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 | |||
34 | Number: 65539 | 34 | Number: 65539 |
35 | Name: VPN | 35 | Name: VPN |
36 | Comment: VPN resolution | 36 | Comment: VPN resolution |
37 | References: https://lsd.gnunet.org/lsd0001 | 37 | References: |
38 | 38 | ||
39 | Number: 65540 | 39 | Number: 65540 |
40 | Name: GNS2DNS | 40 | Name: GNS2DNS |
diff --git a/gnunet-dht-block-types/.gitignore b/gnunet-dht-block-types/.gitignore new file mode 100644 index 0000000..0a437d0 --- /dev/null +++ b/gnunet-dht-block-types/.gitignore | |||
@@ -0,0 +1 @@ | |||
gnu-name-system-record-types.h | |||