mirror of
https://dev.iopsys.eu/bbf/icwmp.git
synced 2025-12-10 07:44:41 +01:00
Re-align doc structure
This commit is contained in:
Vivek Kumar Dutta
parent
c94d21de94
commit
cf391c3604
22 changed files with 10 additions and 13552 deletions
|
|
@ -1,6 +1,7 @@
|
|||
title: "CWMP Agent documentation"
|
||||
title: "CWMP Client"
|
||||
|
||||
nav:
|
||||
- "arch"
|
||||
- "api"
|
||||
- "guide"
|
||||
- "spec"
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
title: "CWMP Agent UBUS"
|
||||
title: "TR069"
|
||||
|
||||
nav:
|
||||
- "..."
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
title: "CWMP Agent UCI"
|
||||
title: "CWMP"
|
||||
|
||||
nav:
|
||||
- "..."
|
||||
|
|
|
|||
Binary file not shown.
File diff suppressed because it is too large
Load diff
|
Before Width: | Height: | Size: 330 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load diff
|
Before Width: | Height: | Size: 329 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -1,124 +0,0 @@
|
|||
////
|
||||
/// Copyright (c) 2016-2021 Martin Donath <martin.donath@squidfunk.com>
|
||||
///
|
||||
/// Permission is hereby granted, free of charge, to any person obtaining a
|
||||
/// copy of this software and associated documentation files (the "Software"),
|
||||
/// to deal in the Software without restriction, including without limitation
|
||||
/// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||
/// and/or sell copies of the Software, and to permit persons to whom the
|
||||
/// Software is furnished to do so, subject to the following conditions:
|
||||
///
|
||||
/// The above copyright notice and this permission notice shall be included in
|
||||
/// all copies or substantial portions of the Software.
|
||||
///
|
||||
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
/// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
/// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
|
||||
/// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
/// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
/// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
/// DEALINGS
|
||||
////
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// Rules
|
||||
// ----------------------------------------------------------------------------
|
||||
|
||||
|
||||
|
||||
// Color variables
|
||||
:root {
|
||||
|
||||
// Default color shades
|
||||
--md-default-fg-color: hsla(0, 0%, 0%, 0.87);
|
||||
--md-default-fg-color--light: hsla(0, 0%, 0%, 0.54);
|
||||
--md-default-fg-color--lighter: hsla(0, 0%, 0%, 0.32);
|
||||
--md-default-fg-color--lightest: hsla(0, 0%, 0%, 0.07);
|
||||
--md-default-bg-color: hsla(0, 0%, 100%, 1);
|
||||
--md-default-bg-color--light: hsla(0, 0%, 100%, 0.7);
|
||||
--md-default-bg-color--lighter: hsla(0, 0%, 100%, 0.3);
|
||||
--md-default-bg-color--lightest: hsla(0, 0%, 100%, 0.12);
|
||||
|
||||
// Primary color shades
|
||||
--md-primary-fg-color: hsla(#{hex2hsl($clr-indigo-500)}, 1);
|
||||
--md-primary-fg-color--light: hsla(#{hex2hsl($clr-indigo-400)}, 1);
|
||||
--md-primary-fg-color--dark: hsla(#{hex2hsl($clr-indigo-700)}, 1);
|
||||
--md-primary-bg-color: hsla(0, 0%, 100%, 1);
|
||||
--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7);
|
||||
|
||||
// Accent color shades
|
||||
--md-accent-fg-color: hsla(#{hex2hsl($clr-indigo-a200)}, 1);
|
||||
--md-accent-fg-color--transparent: hsla(#{hex2hsl($clr-indigo-a200)}, 0.1);
|
||||
--md-accent-bg-color: hsla(0, 0%, 100%, 1);
|
||||
--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7);
|
||||
|
||||
// Light theme (default)
|
||||
> * {
|
||||
|
||||
// Code color shades
|
||||
--md-code-fg-color: hsla(200, 18%, 26%, 1);
|
||||
--md-code-bg-color: hsla(0, 0%, 96%, 1);
|
||||
|
||||
// Code highlighting color shades
|
||||
--md-code-hl-color: hsla(#{hex2hsl($clr-yellow-a200)}, 0.5);
|
||||
--md-code-hl-number-color: hsla(0, 67%, 50%, 1);
|
||||
--md-code-hl-special-color: hsla(340, 83%, 47%, 1);
|
||||
--md-code-hl-function-color: hsla(291, 45%, 50%, 1);
|
||||
--md-code-hl-constant-color: hsla(250, 63%, 60%, 1);
|
||||
--md-code-hl-keyword-color: hsla(219, 54%, 51%, 1);
|
||||
--md-code-hl-string-color: hsla(150, 63%, 30%, 1);
|
||||
--md-code-hl-name-color: var(--md-code-fg-color);
|
||||
--md-code-hl-operator-color: var(--md-default-fg-color--light);
|
||||
--md-code-hl-punctuation-color: var(--md-default-fg-color--light);
|
||||
--md-code-hl-comment-color: var(--md-default-fg-color--light);
|
||||
--md-code-hl-generic-color: var(--md-default-fg-color--light);
|
||||
--md-code-hl-variable-color: var(--md-default-fg-color--light);
|
||||
|
||||
// Typeset color shades
|
||||
--md-typeset-color: var(--md-default-fg-color);
|
||||
|
||||
// Typeset `a` color shades
|
||||
--md-typeset-a-color: var(--md-primary-fg-color);
|
||||
|
||||
// Typeset `mark` color shades
|
||||
--md-typeset-mark-color: hsla(#{hex2hsl($clr-yellow-a200)}, 0.5);
|
||||
|
||||
// Typeset `del` and `ins` color shades
|
||||
--md-typeset-del-color: hsla(6, 90%, 60%, 0.15);
|
||||
--md-typeset-ins-color: hsla(150, 90%, 44%, 0.15);
|
||||
|
||||
// Typeset `kbd` color shades
|
||||
--md-typeset-kbd-color: hsla(0, 0%, 98%, 1);
|
||||
--md-typeset-kbd-accent-color: hsla(0, 100%, 100%, 1);
|
||||
--md-typeset-kbd-border-color: hsla(0, 0%, 72%, 1);
|
||||
|
||||
// Typeset `table` color shades
|
||||
--md-typeset-table-color: hsla(0, 0%, 0%, 0.12);
|
||||
|
||||
// Admonition color shades
|
||||
--md-admonition-fg-color: var(--md-default-fg-color);
|
||||
--md-admonition-bg-color: var(--md-default-bg-color);
|
||||
|
||||
// Footer color shades
|
||||
--md-footer-fg-color: hsla(0, 0%, 100%, 1);
|
||||
--md-footer-fg-color--light: hsla(0, 0%, 100%, 0.7);
|
||||
--md-footer-fg-color--lighter: hsla(0, 0%, 100%, 0.3);
|
||||
--md-footer-bg-color: hsla(0, 0%, 0%, 0.87);
|
||||
--md-footer-bg-color--dark: hsla(0, 0%, 0%, 0.32);
|
||||
}
|
||||
|
||||
// Shadow depth 1
|
||||
--md-shadow-z1:
|
||||
0 #{px2rem(4px)} #{px2rem(10px)} hsla(0, 0%, 0%, 0.05),
|
||||
0 0 #{px2rem(1px)} hsla(0, 0%, 0%, 0.1);
|
||||
|
||||
// Shadow depth 2
|
||||
--md-shadow-z2:
|
||||
0 #{px2rem(4px)} #{px2rem(10px)} hsla(0, 0%, 0%, 0.1),
|
||||
0 0 #{px2rem(1px)} hsla(0, 0%, 0%, 0.25);
|
||||
|
||||
// Shadow depth 3
|
||||
--md-shadow-z3:
|
||||
0 #{px2rem(4px)} #{px2rem(10px)} hsla(0, 0%, 0%, 0.2),
|
||||
0 0 #{px2rem(1px)} hsla(0, 0%, 0%, 0.35);
|
||||
}
|
||||
2601
docs/css/extra.css
2601
docs/css/extra.css
File diff suppressed because it is too large
Load diff
|
|
@ -1,28 +0,0 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 24.2.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" id="Lager_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 460 84" style="enable-background:new 0 0 460 84;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{fill:#FFFFFF;}
|
||||
</style>
|
||||
<g>
|
||||
<g>
|
||||
<rect x="2.8" y="4.3" class="st0" width="16.7" height="76.1"/>
|
||||
<path class="st0" d="M88.8,3C65.3,3,48.3,20.8,48.3,42.4v0.2c0,21.6,16.9,39.1,40.3,39.1c23.5,0,40.6-17.7,40.6-39.4v-0.2
|
||||
C129.1,20.5,112.3,3,88.8,3z M111.6,42.6c0,13-9.4,23.7-22.8,23.7c-13.5,0-23-10.9-23-23.9v-0.2c0-13,9.4-23.7,22.8-23.7
|
||||
c13.5,0,23.1,10.9,23.1,23.9v0.2H111.6z"/>
|
||||
<path class="st0" d="M271.4,34.9c-13.2-3.4-16.4-5-16.4-10v-0.2c0-3.7,3.4-6.6,9.8-6.6s13,2.8,19.8,7.5l8.7-12.6
|
||||
c-7.7-6.2-17.2-9.7-28.3-9.7c-15.5,0-26.6,9.1-26.6,22.9v0.2c0,15.1,9.9,19.4,25.2,23.3c12.7,3.3,15.3,5.4,15.3,9.7v0.2
|
||||
c0,4.5-4.1,7.2-11,7.2c-8.7,0-15.9-3.6-22.7-9.2l-9.9,11.9c9.1,8.2,20.8,12.2,32.3,12.2c16.4,0,27.9-8.5,27.9-23.6v-0.2
|
||||
C295.5,44.5,286.8,38.9,271.4,34.9z"/>
|
||||
<polygon class="st0" points="347.3,34.9 329.1,4.3 309.5,4.3 338.8,50.4 338.8,80.4 355.5,80.4 355.5,50.1 384.8,4.3 365.7,4.3
|
||||
"/>
|
||||
<path class="st0" d="M432.2,34.9c-13.2-3.4-16.4-5-16.4-10v-0.2c0-3.7,3.4-6.6,9.8-6.6s13,2.8,19.8,7.5l8.7-12.6
|
||||
c-7.7-6.2-17.2-9.7-28.3-9.7c-15.6,0-26.6,9.1-26.6,22.9v0.2c0,15.1,9.9,19.4,25.2,23.3c12.7,3.3,15.3,5.4,15.3,9.7v0.2
|
||||
c0,4.5-4.1,7.2-11,7.2c-8.7,0-15.9-3.6-22.7-9.2l-9.9,11.9c9.1,8.2,20.8,12.2,32.3,12.2c16.4,0,27.9-8.5,27.9-23.6v-0.2
|
||||
C456.3,44.5,447.6,38.9,432.2,34.9z"/>
|
||||
<path class="st0" d="M186,4.3h-31.5v15.3h30c8.5,0,13.8,4.1,13.8,11.7v0.2c0,6.6-5,11.7-13.4,11.7h-30.4v37.2h16.9V58.3h12.9
|
||||
c17.3,0,31.1-9.2,31.1-27.1V31C215.5,15.2,204.3,4.3,186,4.3z"/>
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.8 KiB |
|
|
@ -1,17 +0,0 @@
|
|||
@page {
|
||||
size: a4 portrait;
|
||||
margin: 25mm 10mm 25mm 10mm;
|
||||
counter-increment: page;
|
||||
font-family: 'Madera', 'Lucida Sans Unicode', 'Lucida Grande', sans-serif;
|
||||
white-space: pre;
|
||||
color: grey;
|
||||
@top-left {
|
||||
content: '© 2022 IOPSYS';
|
||||
}
|
||||
@top-center {
|
||||
content: string(chapter);
|
||||
}
|
||||
@top-right {
|
||||
content: 'Page ' counter(page);
|
||||
}
|
||||
}
|
||||
|
|
@ -1,90 +0,0 @@
|
|||
site_name: Documentation Instructions
|
||||
site_url: https://docs.iopsys.se/portal2/icwmp/
|
||||
edit_uri: "https://dev.iopsys.eu/docs/portal2/icwmp"
|
||||
|
||||
site_description: IOWRT Technical Documentation
|
||||
site_author: IOPSYS
|
||||
|
||||
docs_dir: '.'
|
||||
site_dir: 'site'
|
||||
|
||||
|
||||
theme:
|
||||
name: material
|
||||
include_sidebar: true
|
||||
highlightjs: true
|
||||
hljs_languages:
|
||||
- yaml
|
||||
- python
|
||||
language: en
|
||||
font:
|
||||
text: Roboto
|
||||
code: Roboto Mono
|
||||
logo: iopsys-white.svg
|
||||
icon:
|
||||
logo: icon.png
|
||||
repo: fontawesome/brands/gitlab
|
||||
extra:
|
||||
social:
|
||||
- icon: fontawesome/brands/github-alt
|
||||
link: https://github.com/squidfunk
|
||||
features:
|
||||
- toc.autohide
|
||||
- navigation.tabs
|
||||
- navigation.tabs.sticky
|
||||
- navigation.top
|
||||
- navigation.tracking
|
||||
- navigation.expand
|
||||
|
||||
palette:
|
||||
# Primary color used for header, sidebar and links, default: indigo
|
||||
primary: black
|
||||
# Accent color for highlighting user interaction, default: indigo
|
||||
accent: deep orange
|
||||
|
||||
extra_css:
|
||||
- css/extra.css
|
||||
- https://unpkg.com/mermaid@8.5.1/dist/mermaid.css
|
||||
- https://cdn.jsdelivr.net/gh/fancyapps/fancybox@3.5.7/dist/jquery.fancybox.min.css
|
||||
|
||||
extra_javascript:
|
||||
- https://unpkg.com/mermaid/dist/mermaid.min.js
|
||||
- https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js
|
||||
- https://cdn.jsdelivr.net/gh/fancyapps/fancybox@3.5.7/dist/jquery.fancybox.min.js
|
||||
|
||||
markdown_extensions:
|
||||
- meta
|
||||
- admonition
|
||||
- pymdownx.arithmatex
|
||||
- pymdownx.betterem:
|
||||
smart_enable: all
|
||||
- pymdownx.caret
|
||||
- pymdownx.critic
|
||||
- pymdownx.details
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.magiclink
|
||||
- pymdownx.mark
|
||||
- pymdownx.smartsymbols
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- pymdownx.tilde
|
||||
- pymdownx.superfences:
|
||||
# make exceptions to highlighting of code:
|
||||
custom_fences:
|
||||
- name: mermaid
|
||||
class: mermaid
|
||||
format: !!python/name:mermaid2.fence_mermaid
|
||||
- fontawesome_markdown
|
||||
|
||||
plugins:
|
||||
- search:
|
||||
lang:
|
||||
- en
|
||||
separator: '[\s\-\.]+'
|
||||
- awesome-pages:
|
||||
collapse_single_pages: true
|
||||
- mermaid2
|
||||
- section-index
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
#!/usr/bin/env bash
|
||||
|
||||
# Copy README.md as index.md and change links
|
||||
pip install -r requirements.txt
|
||||
|
||||
# Copy README.md as index.md and change links
|
||||
sed -r -e 's![\.\/]*docs[\/]*!./!g' ../README.md > index.md
|
||||
|
||||
# Start mkdocs local server
|
||||
mkdocs serve -f mkdocs.yml
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
mkdocs
|
||||
mkdocs-material
|
||||
mkdocs-awesome-pages-plugin
|
||||
mkdocs-section-index
|
||||
fontawesome_markdown
|
||||
mkdocs-print-site-plugin
|
||||
mkdocs-mermaid2-plugin
|
||||
|
|
@ -143,8 +143,8 @@ function install_bbfdmd()
|
|||
fi
|
||||
|
||||
cd /opt/dev/bbfdm
|
||||
cmake CMakeLists.txt -DBBFDMD_ENABLED=ON -DBBF_TR181=ON -DBBF_TR104=ON -DBBF_TR143=ON -DWITH_OPENSSL=ON -DBBF_JSON_PLUGIN=ON -DBBF_DOTSO_PLUGIN=ON -DBBF_VENDOR_EXTENSION=ON -DBBF_VENDOR_LIST="iopsys" -DBBF_VENDOR_PREFIX="X_IOPSYS_EU_" -DBBF_MAX_OBJECT_INSTANCES=255 -DCMAKE_INSTALL_PREFIX=/
|
||||
make && make install
|
||||
./gitlab-ci/install-dependencies.sh install
|
||||
./gitlab-ci/setup.sh install
|
||||
}
|
||||
|
||||
function check_valgrind_xml() {
|
||||
|
|
|
|||
89
mkdocs.yml
89
mkdocs.yml
|
|
@ -1,90 +1,9 @@
|
|||
site_name: BroadBand Forum Data Models (BBFDM)
|
||||
site_url: https://dev.iopsys.eu/iopsys/icwmp
|
||||
edit_uri: "https://dev.iopsys.eu/iopsys/icwmp"
|
||||
site_name: TR-x69
|
||||
site_url: https://dev.iopsys.eu/bbf/icwmp
|
||||
edit_uri: "https://dev.iopsys.eu/bbf/icwmp"
|
||||
|
||||
site_description: IOWRT Technical Documentation
|
||||
site_description: CWMP Client based on TR069
|
||||
site_author: IOPSYS
|
||||
|
||||
docs_dir: 'docs'
|
||||
site_dir: 'site'
|
||||
|
||||
|
||||
theme:
|
||||
name: material
|
||||
include_sidebar: true
|
||||
highlightjs: true
|
||||
hljs_languages:
|
||||
- yaml
|
||||
- python
|
||||
language: en
|
||||
font:
|
||||
text: Roboto
|
||||
code: Roboto Mono
|
||||
logo: iopsys-white.svg
|
||||
icon:
|
||||
logo: icon.png
|
||||
repo: fontawesome/brands/gitlab
|
||||
extra:
|
||||
social:
|
||||
- icon: fontawesome/brands/github-alt
|
||||
link: https://github.com/squidfunk
|
||||
features:
|
||||
- toc.autohide
|
||||
- navigation.tabs
|
||||
- navigation.tabs.sticky
|
||||
- navigation.top
|
||||
- navigation.tracking
|
||||
- navigation.expand
|
||||
|
||||
palette:
|
||||
# Primary color used for header, sidebar and links, default: indigo
|
||||
primary: black
|
||||
# Accent color for highlighting user interaction, default: indigo
|
||||
accent: deep orange
|
||||
|
||||
extra_css:
|
||||
- css/extra.css
|
||||
- https://unpkg.com/mermaid@8.5.1/dist/mermaid.css
|
||||
- https://cdn.jsdelivr.net/gh/fancyapps/fancybox@3.5.7/dist/jquery.fancybox.min.css
|
||||
|
||||
extra_javascript:
|
||||
- https://unpkg.com/mermaid/dist/mermaid.min.js
|
||||
- https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js
|
||||
- https://cdn.jsdelivr.net/gh/fancyapps/fancybox@3.5.7/dist/jquery.fancybox.min.js
|
||||
|
||||
markdown_extensions:
|
||||
- meta
|
||||
- admonition
|
||||
- pymdownx.arithmatex
|
||||
- pymdownx.betterem:
|
||||
smart_enable: all
|
||||
- pymdownx.caret
|
||||
- pymdownx.critic
|
||||
- pymdownx.details
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.magiclink
|
||||
- pymdownx.mark
|
||||
- pymdownx.smartsymbols
|
||||
- pymdownx.tasklist:
|
||||
custom_checkbox: true
|
||||
- pymdownx.tilde
|
||||
- pymdownx.superfences:
|
||||
# make exceptions to highlighting of code:
|
||||
custom_fences:
|
||||
- name: mermaid
|
||||
class: mermaid
|
||||
format: !!python/name:mermaid2.fence_mermaid
|
||||
- fontawesome_markdown
|
||||
|
||||
plugins:
|
||||
- search:
|
||||
lang:
|
||||
- en
|
||||
separator: '[\s\-\.]+'
|
||||
- awesome-pages:
|
||||
collapse_single_pages: true
|
||||
- mermaid2
|
||||
- section-index
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue