From f7151d2c553cbd4d14d2885c3c63627496ce910c Mon Sep 17 00:00:00 2001 From: Raphael Riebl Date: Mon, 6 Jul 2020 14:46:27 +0200 Subject: [PATCH] update mkdocs Change-Id: I785b0cf2d9998fe73fab433db6899bc05c0951e9 --- docs/how-to-build.md | 3 +- docs/legal.md | 6 +- docs/recipes/cohda-sdk-build.md | 2 + docs/recipes/cross-compile-dependencies.md | 8 +- docs/tools/benchmark.md | 2 + docs/tools/certify.md | 2 + docs/tools/socktap.md | 5 +- mkdocs.yml | 5 +- mkdocs/css/extra.css | 20 ++- mkdocs/css/tango.css | 154 ++++++++++----------- mkdocs/js/extra.js | 10 ++ mkdocs/search.html | 16 --- 12 files changed, 124 insertions(+), 109 deletions(-) create mode 100644 mkdocs/js/extra.js delete mode 100644 mkdocs/search.html diff --git a/docs/how-to-build.md b/docs/how-to-build.md index 94256cc7b..ed6f2f50d 100644 --- a/docs/how-to-build.md +++ b/docs/how-to-build.md @@ -1,5 +1,4 @@ -Title: How to build - +# How to build Building Vanetza is accomplished by the [CMake](https://cmake.org) build system. Hence, CMake needs to be available on the build host. diff --git a/docs/legal.md b/docs/legal.md index 537a497a1..16d08684b 100644 --- a/docs/legal.md +++ b/docs/legal.md @@ -1,10 +1,10 @@ -Title: Legal Notice +# Legal Notice As maintainer of Vanetza, I am responsible for this website's content under German Law. Following contact details are given to comply with § 5 TMG and § 55 Abs. 2 RStV. Feel free to send me a postcard if you like Vanetza :-) -# Contact +## Contact Raphael Riebl Bergstraße 9 @@ -17,7 +17,7 @@ I will not answer support requests via e-mail. Please open an [issue ticket](https://github.com/riebl/vanetza/issues) instead. -# Privacy Statement +## Privacy Statement I do not collect, store or process any information about visitors of this website. Please note that the API documentation generated by Doxygen sets a non-essential cookie storing your preferred width of its navigation's sidebar. diff --git a/docs/recipes/cohda-sdk-build.md b/docs/recipes/cohda-sdk-build.md index 3e0e92f2a..cc2feadd4 100644 --- a/docs/recipes/cohda-sdk-build.md +++ b/docs/recipes/cohda-sdk-build.md @@ -1,3 +1,5 @@ +Title: Building for Cohda MK5 + # Building Vanetza for Cohda MK5 using Cohda SDK This document describes step-by-step how to build Vanetza using the Cohda SDK. diff --git a/docs/recipes/cross-compile-dependencies.md b/docs/recipes/cross-compile-dependencies.md index 3b42c4a11..d249c7df3 100644 --- a/docs/recipes/cross-compile-dependencies.md +++ b/docs/recipes/cross-compile-dependencies.md @@ -1,8 +1,10 @@ +# Cross-Compilation of Dependencies + This document summarises a few hints for cross-compiling Vanetza's dependencies. Please note, that cross-compiling is not relevant for you if you plan to use Vanetza on the same system you have built it on. -# Boost +## Boost Create a configuration file for Boost.Build in your home directory at `$HOME/user-config.jam` and add following line to it: @@ -29,7 +31,7 @@ Then, the required libraries can be built and installed at given *prefix* path: ./b2 --prefix=$HOME/vanetza-deps --with-date_time --with-program_options --with-system --no-samples --no-tests variant=release link=shared cxxstd=11 install -# Crypto++ +## Crypto++ Version 8.2 can be cross-compiled with the provided `GNUmakefile-cross` makefile. @@ -41,7 +43,7 @@ Version 8.2 can be cross-compiled with the provided `GNUmakefile-cross` makefile make -f GNUmakefile-cross install -# GeographicLib +## GeographicLib Following steps have been tested with version 1.50. `$VANETZA` refers to the root directory of this repository. diff --git a/docs/tools/benchmark.md b/docs/tools/benchmark.md index 76728b17e..627851575 100644 --- a/docs/tools/benchmark.md +++ b/docs/tools/benchmark.md @@ -1,3 +1,5 @@ +# Benchmark + *Benchmark* is a tool to benchmark some components of Vanetza. At the moment, benchmarks for signing and validating packets exist. diff --git a/docs/tools/certify.md b/docs/tools/certify.md index 21a22141d..6b65612c2 100644 --- a/docs/tools/certify.md +++ b/docs/tools/certify.md @@ -1,3 +1,5 @@ +# Certify + *Certify* is a tool to create and view certificates and can be used to set up a test PKI for secured V2X communication based on TS 103 097 v1.2.1. ## Installation diff --git a/docs/tools/socktap.md b/docs/tools/socktap.md index 5a69670f9..1aef22581 100644 --- a/docs/tools/socktap.md +++ b/docs/tools/socktap.md @@ -1,10 +1,9 @@ +# Socktap + Vanetza ships with a simple demo application called *socktap*. You can enable the build process for this application by the `BUILD_SOCKTAP` CMake option. When *socktap* is going to be built, [gpsd](http://catb.org/gpsd) is required as an additional dependency. - -# Vanetza tapping on sockets - *socktap* runs Vanetza on top of Linux raw packet sockets and demonstrates the basic API usage. This enables tests on commodity hardware, i.e. no special V2X or Car2X hardware is required. However, raw packet sockets cannot replace such dedicated hardware entirly. diff --git a/mkdocs.yml b/mkdocs.yml index e0b281886..5e5c195cf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,15 +5,18 @@ theme: name: readthedocs custom_dir: mkdocs/ highlightjs: false + collapse_navigation: false extra_css: - css/extra.css - css/tango.css +extra_javascript: + - js/extra.js markdown_extensions: + - admonition - smarty - sane_lists - codehilite: guess_lang: false - css_class: highlight plugins: - awesome-pages: collapse_single_pages: true diff --git a/mkdocs/css/extra.css b/mkdocs/css/extra.css index 814a3b353..427f92c19 100644 --- a/mkdocs/css/extra.css +++ b/mkdocs/css/extra.css @@ -57,6 +57,22 @@ a:visited { color: #0d1f2d; } +.wy-menu-vertical p.caption { + padding: 0 0.6em; +} + +.wy-menu-vertical .caption-text { + color: #d0d0d0; +} + +.wy-menu-vertical .toctree-expand::before { + color: #d0d0d0; +} + +.wy-menu-vertical li.current .toctree-expand::before { + color: #0d1f2d; +} + .wy-menu-vertical li.current a { color: #394753; } @@ -72,7 +88,3 @@ a:visited { .wy-menu-vertical a:hover { background-color: #51637d; } - -pre, code { - font-size: 16px; -} diff --git a/mkdocs/css/tango.css b/mkdocs/css/tango.css index 0fa0beaa2..76d5065ce 100644 --- a/mkdocs/css/tango.css +++ b/mkdocs/css/tango.css @@ -1,77 +1,77 @@ -.highlight .hll { background-color: #ffffcc } -.highlight { background: #f8f8f8; } -.highlight .c { color: #8f5902; font-style: italic } /* Comment */ -.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ -.highlight .g { color: #000000 } /* Generic */ -.highlight .k { color: #204a87; font-weight: bold } /* Keyword */ -.highlight .l { color: #000000 } /* Literal */ -.highlight .n { color: #000000 } /* Name */ -.highlight .o { color: #ce5c00; font-weight: bold } /* Operator */ -.highlight .x { color: #000000 } /* Other */ -.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ -.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ -.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ -.highlight .cp { color: #8f5902; font-style: italic } /* Comment.Preproc */ -.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ -.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ -.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ -.highlight .gd { color: #a40000 } /* Generic.Deleted */ -.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ -.highlight .gr { color: #ef2929 } /* Generic.Error */ -.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ -.highlight .gi { color: #00A000 } /* Generic.Inserted */ -.highlight .go { color: #000000; font-style: italic } /* Generic.Output */ -.highlight .gp { color: #8f5902 } /* Generic.Prompt */ -.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ -.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ -.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ -.highlight .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */ -.highlight .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */ -.highlight .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */ -.highlight .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */ -.highlight .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */ -.highlight .kt { color: #204a87; font-weight: bold } /* Keyword.Type */ -.highlight .ld { color: #000000 } /* Literal.Date */ -.highlight .m { color: #0000cf; font-weight: bold } /* Literal.Number */ -.highlight .s { color: #4e9a06 } /* Literal.String */ -.highlight .na { color: #c4a000 } /* Name.Attribute */ -.highlight .nb { color: #204a87 } /* Name.Builtin */ -.highlight .nc { color: #000000 } /* Name.Class */ -.highlight .no { color: #000000 } /* Name.Constant */ -.highlight .nd { color: #5c35cc; font-weight: bold } /* Name.Decorator */ -.highlight .ni { color: #ce5c00 } /* Name.Entity */ -.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ -.highlight .nf { color: #000000 } /* Name.Function */ -.highlight .nl { color: #f57900 } /* Name.Label */ -.highlight .nn { color: #000000 } /* Name.Namespace */ -.highlight .nx { color: #000000 } /* Name.Other */ -.highlight .py { color: #000000 } /* Name.Property */ -.highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */ -.highlight .nv { color: #000000 } /* Name.Variable */ -.highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */ -.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ -.highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ -.highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ -.highlight .mh { color: #0000cf; font-weight: bold } /* Literal.Number.Hex */ -.highlight .mi { color: #0000cf; font-weight: bold } /* Literal.Number.Integer */ -.highlight .mo { color: #0000cf; font-weight: bold } /* Literal.Number.Oct */ -.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ -.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ -.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ -.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ -.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ -.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ -.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ -.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ -.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ -.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ -.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ -.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ -.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ -.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #000000 } /* Name.Function.Magic */ -.highlight .vc { color: #000000 } /* Name.Variable.Class */ -.highlight .vg { color: #000000 } /* Name.Variable.Global */ -.highlight .vi { color: #000000 } /* Name.Variable.Instance */ -.highlight .vm { color: #000000 } /* Name.Variable.Magic */ -.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */ +.codehilite .hll { background-color: #ffffcc } +.codehilite { background: #f8f8f8; } +.codehilite .c { color: #8f5902; font-style: italic } /* Comment */ +.codehilite .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ +.codehilite .g { color: #000000 } /* Generic */ +.codehilite .k { color: #204a87; font-weight: bold } /* Keyword */ +.codehilite .l { color: #000000 } /* Literal */ +.codehilite .n { color: #000000 } /* Name */ +.codehilite .o { color: #ce5c00; font-weight: bold } /* Operator */ +.codehilite .x { color: #000000 } /* Other */ +.codehilite .p { color: #000000; font-weight: bold } /* Punctuation */ +.codehilite .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ +.codehilite .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +.codehilite .cp { color: #8f5902; font-style: italic } /* Comment.Preproc */ +.codehilite .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ +.codehilite .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +.codehilite .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +.codehilite .gd { color: #a40000 } /* Generic.Deleted */ +.codehilite .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.codehilite .gr { color: #ef2929 } /* Generic.Error */ +.codehilite .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.codehilite .gi { color: #00A000 } /* Generic.Inserted */ +.codehilite .go { color: #000000; font-style: italic } /* Generic.Output */ +.codehilite .gp { color: #8f5902 } /* Generic.Prompt */ +.codehilite .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.codehilite .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.codehilite .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +.codehilite .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */ +.codehilite .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */ +.codehilite .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */ +.codehilite .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */ +.codehilite .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */ +.codehilite .kt { color: #204a87; font-weight: bold } /* Keyword.Type */ +.codehilite .ld { color: #000000 } /* Literal.Date */ +.codehilite .m { color: #0000cf; font-weight: bold } /* Literal.Number */ +.codehilite .s { color: #4e9a06 } /* Literal.String */ +.codehilite .na { color: #c4a000 } /* Name.Attribute */ +.codehilite .nb { color: #204a87 } /* Name.Builtin */ +.codehilite .nc { color: #000000 } /* Name.Class */ +.codehilite .no { color: #000000 } /* Name.Constant */ +.codehilite .nd { color: #5c35cc; font-weight: bold } /* Name.Decorator */ +.codehilite .ni { color: #ce5c00 } /* Name.Entity */ +.codehilite .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +.codehilite .nf { color: #000000 } /* Name.Function */ +.codehilite .nl { color: #f57900 } /* Name.Label */ +.codehilite .nn { color: #000000 } /* Name.Namespace */ +.codehilite .nx { color: #000000 } /* Name.Other */ +.codehilite .py { color: #000000 } /* Name.Property */ +.codehilite .nt { color: #204a87; font-weight: bold } /* Name.Tag */ +.codehilite .nv { color: #000000 } /* Name.Variable */ +.codehilite .ow { color: #204a87; font-weight: bold } /* Operator.Word */ +.codehilite .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */ +.codehilite .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */ +.codehilite .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */ +.codehilite .mh { color: #0000cf; font-weight: bold } /* Literal.Number.Hex */ +.codehilite .mi { color: #0000cf; font-weight: bold } /* Literal.Number.Integer */ +.codehilite .mo { color: #0000cf; font-weight: bold } /* Literal.Number.Oct */ +.codehilite .sa { color: #4e9a06 } /* Literal.String.Affix */ +.codehilite .sb { color: #4e9a06 } /* Literal.String.Backtick */ +.codehilite .sc { color: #4e9a06 } /* Literal.String.Char */ +.codehilite .dl { color: #4e9a06 } /* Literal.String.Delimiter */ +.codehilite .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ +.codehilite .s2 { color: #4e9a06 } /* Literal.String.Double */ +.codehilite .se { color: #4e9a06 } /* Literal.String.Escape */ +.codehilite .sh { color: #4e9a06 } /* Literal.String.Heredoc */ +.codehilite .si { color: #4e9a06 } /* Literal.String.Interpol */ +.codehilite .sx { color: #4e9a06 } /* Literal.String.Other */ +.codehilite .sr { color: #4e9a06 } /* Literal.String.Regex */ +.codehilite .s1 { color: #4e9a06 } /* Literal.String.Single */ +.codehilite .ss { color: #4e9a06 } /* Literal.String.Symbol */ +.codehilite .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +.codehilite .fm { color: #000000 } /* Name.Function.Magic */ +.codehilite .vc { color: #000000 } /* Name.Variable.Class */ +.codehilite .vg { color: #000000 } /* Name.Variable.Global */ +.codehilite .vi { color: #000000 } /* Name.Variable.Instance */ +.codehilite .vm { color: #000000 } /* Name.Variable.Magic */ +.codehilite .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */ diff --git a/mkdocs/js/extra.js b/mkdocs/js/extra.js new file mode 100644 index 000000000..ef3e89644 --- /dev/null +++ b/mkdocs/js/extra.js @@ -0,0 +1,10 @@ +document.addEventListener("DOMContentLoaded", function() { + document.querySelectorAll("table").forEach(function(table) { + table.classList.add("docutils"); + }); + document.querySelectorAll("td").forEach(function(cell) { + if (cell.innerText.length > 40) { + cell.style.whiteSpace = "normal"; + } + }); +}); diff --git a/mkdocs/search.html b/mkdocs/search.html deleted file mode 100644 index b35f0b8fa..000000000 --- a/mkdocs/search.html +++ /dev/null @@ -1,16 +0,0 @@ -{% extends "main.html" %} - -{% block content %} - -

Search Results

- -
- - -
- -
- Searching... -
- -{% endblock %}