Skip to content

Commit e72ebf8

Browse files
naushirnaushir
committed
Merge branch 'master' into next
2 parents 35b6684 + b9fa6e0 commit e72ebf8

File tree

142 files changed

+8604
-1157
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

142 files changed

+8604
-1157
lines changed

‎.reuse/dep5‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,10 @@ Source: https://git.libcamera.org/libcamera/libcamera.git/
66
Files: Documentation/binning.svg
77
Documentation/camera-sensor-model.rst
88
Documentation/sensor_model.svg
9+
Documentation/theme/static/libcamera-logo-text.svg
910
Copyright: Copyright 2023 Ideas On Board Oy
1011
License: CC-BY-SA-4.0
1112

12-
Files: Documentation/theme/static/search.png
13-
Copyright: 2022 Fonticons, Inc.
14-
License: CC-BY-4.0
15-
1613
Files: src/ipa/rpi/vc4/data/*.json
1714
utils/raspberrypi/ctt/ctt_config_example.json
1815
utils/raspberrypi/ctt/ctt_ref.pgm

‎Documentation/Doxyfile-common.in‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ FILE_PATTERNS = *.c \
2929

3030
RECURSIVE = YES
3131

32+
EXCLUDE_SYMLINKS = YES
33+
3234
EXCLUDE_PATTERNS = @TOP_BUILDDIR@/include/libcamera/ipa/*_serializer.h \
3335
@TOP_BUILDDIR@/include/libcamera/ipa/*_proxy.h \
3436
@TOP_BUILDDIR@/include/libcamera/ipa/ipu3_*.h \
@@ -50,7 +52,10 @@ EXCLUDE_SYMBOLS = libcamera::BoundMethodArgs \
5052
*::details \
5153
std::*
5254

53-
EXCLUDE_SYMLINKS = YES
55+
IMAGE_PATH = "@TOP_SRCDIR@/Documentation/images"
56+
57+
HTML_EXTRA_STYLESHEET = "@TOP_SRCDIR@/Documentation/doxygen-awesome-css/doxygen-awesome.css" \
58+
"@TOP_SRCDIR@/Documentation/doxygen-awesome-css/doxygen-awesome-sidebar-only.css"
5459

5560
GENERATE_LATEX = NO
5661

@@ -61,8 +66,6 @@ INCLUDE_PATH = "@TOP_BUILDDIR@/include" \
6166
"@TOP_SRCDIR@/include"
6267
INCLUDE_FILE_PATTERNS = *.h
6368

64-
IMAGE_PATH = "@TOP_SRCDIR@/Documentation/images"
65-
6669
PREDEFINED = __DOXYGEN__ \
6770
__cplusplus \
6871
__attribute__(x)= \

‎Documentation/Doxyfile-internal.in‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@
33
@INCLUDE_PATH = @TOP_BUILDDIR@/Documentation
44
@INCLUDE = Doxyfile-common
55

6-
GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml
7-
8-
HIDE_UNDOC_CLASSES = NO
96
HIDE_UNDOC_MEMBERS = NO
10-
HTML_OUTPUT = internal-api-html
7+
HIDE_UNDOC_CLASSES = NO
118
INTERNAL_DOCS = YES
129
ENABLED_SECTIONS = internal
1310

@@ -33,3 +30,7 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/span.h \
3330
@TOP_BUILDDIR@/include/libcamera/internal/tracepoints.h \
3431
@TOP_BUILDDIR@/include/libcamera/ipa/soft_ipa_interface.h \
3532
@TOP_BUILDDIR@/src/libcamera/proxy/
33+
34+
HTML_OUTPUT = internal-api
35+
36+
GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml

‎Documentation/Doxyfile-public.in‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,8 @@
33
@INCLUDE_PATH = @TOP_BUILDDIR@/Documentation
44
@INCLUDE = Doxyfile-common
55

6-
GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/api-html/tagfile.xml
7-
8-
HIDE_UNDOC_CLASSES = YES
96
HIDE_UNDOC_MEMBERS = YES
10-
HTML_OUTPUT = api-html
7+
HIDE_UNDOC_CLASSES = YES
118
INTERNAL_DOCS = NO
129

1310
INPUT = "@TOP_SRCDIR@/Documentation" \
@@ -19,4 +16,8 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/class.h \
1916
@TOP_SRCDIR@/src/libcamera/base/class.cpp \
2017
@TOP_SRCDIR@/src/libcamera/base/object.cpp
2118

19+
HTML_OUTPUT = public-api
20+
2221
PREDEFINED += __DOXYGEN_PUBLIC__
22+
23+
GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/public-api/tagfile.xml

‎Documentation/camera-sensor-model.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
.. SPDX-License-Identifier: CC-BY-SA-4.0
22
3-
.. include:: documentation-contents.rst
4-
53
.. _camera-sensor-model:
64

75
.. todo: Move to Doxygen-generated documentation

‎Documentation/code-of-conduct.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
.. SPDX-License-Identifier: CC-BY-4.0
22
3-
.. include:: documentation-contents.rst
4-
53
.. _code-of-conduct:
64

75
Contributor Covenant Code of Conduct

‎Documentation/coding-style.rst‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
.. SPDX-License-Identifier: CC-BY-SA-4.0
22
3-
.. include:: documentation-contents.rst
4-
53
.. _coding-style-guidelines:
64

75
Coding Style Guidelines

‎Documentation/conf.py.in‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -66,20 +66,19 @@ language = 'en'
6666
# directories to ignore when looking for source files.
6767
# This pattern also affects html_static_path and html_extra_path.
6868
exclude_patterns = [
69-
'documentation-contents.rst',
7069
]
7170

7271
# The name of the Pygments (syntax highlighting) style to use.
7372
pygments_style = None
7473

7574
doxylink = {
7675
'doxy-pub': (
77-
'@TOP_BUILDDIR@/Documentation/api-html/tagfile.xml',
78-
'../api-html/',
76+
'@TOP_BUILDDIR@/Documentation/public-api/tagfile.xml',
77+
'public-api/',
7978
),
8079
'doxy-int': (
81-
'@TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml',
82-
'../internal-api-html/',
80+
'@TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml',
81+
'internal-api/',
8382
),
8483
}
8584

@@ -88,8 +87,16 @@ doxylink = {
8887
# The theme to use for HTML and HTML Help pages. See the documentation for
8988
# a list of builtin themes.
9089
#
91-
html_theme = 'theme'
92-
html_theme_path = ['@THEME_DIR@']
90+
html_theme = 'sphinx_book_theme'
91+
html_theme_path = []
92+
93+
html_logo = '@CURRENT_SRCDIR@/theme/static/libcamera-logo-text.svg'
94+
95+
html_context = {
96+
# Set the default mode, so that syntax highlighting works without
97+
# javascript.
98+
'default_mode': 'light'
99+
}
93100

94101
# Theme options are theme-specific and customize the look and feel of a theme
95102
# further. For a list of options available for each theme, see the

‎Documentation/documentation-contents.rst‎

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎Documentation/doxygen-awesome-css/doxygen-awesome-sidebar-only.css‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
/* SPDX-License-Identifier: MIT */
2+
/**
3+
4+
Doxygen Awesome
5+
https://github.com/jothepro/doxygen-awesome-css
6+
7+
Copyright (c) 2021 - 2023 jothepro
8+
9+
*/
10+
11+
html {
12+
/* side nav width. MUST be = `TREEVIEW_WIDTH`.
13+
* Make sure it is wide enough to contain the page title (logo + title + version)
14+
*/
15+
--side-nav-fixed-width: 335px;
16+
--menu-display: none;
17+
18+
--top-height: 120px;
19+
--toc-sticky-top: -25px;
20+
--toc-max-height: calc(100vh - 2 * var(--spacing-medium) - 25px);
21+
}
22+
23+
#projectname {
24+
white-space: nowrap;
25+
}
26+
27+
28+
@media screen and (min-width: 768px) {
29+
html {
30+
--searchbar-background: var(--page-background-color);
31+
}
32+
33+
#side-nav {
34+
min-width: var(--side-nav-fixed-width);
35+
max-width: var(--side-nav-fixed-width);
36+
top: var(--top-height);
37+
overflow: visible;
38+
}
39+
40+
#nav-tree, #side-nav {
41+
height: calc(100vh - var(--top-height)) !important;
42+
}
43+
44+
#nav-tree {
45+
padding: 0;
46+
}
47+
48+
#top {
49+
display: block;
50+
border-bottom: none;
51+
height: var(--top-height);
52+
margin-bottom: calc(0px - var(--top-height));
53+
max-width: var(--side-nav-fixed-width);
54+
overflow: hidden;
55+
background: var(--side-nav-background);
56+
}
57+
#main-nav {
58+
float: left;
59+
padding-right: 0;
60+
}
61+
62+
.ui-resizable-handle {
63+
cursor: default;
64+
width: 1px !important;
65+
background: var(--separator-color);
66+
box-shadow: 0 calc(-2 * var(--top-height)) 0 0 var(--separator-color);
67+
}
68+
69+
#nav-path {
70+
position: fixed;
71+
right: 0;
72+
left: var(--side-nav-fixed-width);
73+
bottom: 0;
74+
width: auto;
75+
}
76+
77+
#doc-content {
78+
height: calc(100vh - 31px) !important;
79+
padding-bottom: calc(3 * var(--spacing-large));
80+
padding-top: calc(var(--top-height) - 80px);
81+
box-sizing: border-box;
82+
margin-left: var(--side-nav-fixed-width) !important;
83+
}
84+
85+
#MSearchBox {
86+
width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)));
87+
}
88+
89+
#MSearchField {
90+
width: calc(var(--side-nav-fixed-width) - calc(2 * var(--spacing-medium)) - 65px);
91+
}
92+
93+
#MSearchResultsWindow {
94+
left: var(--spacing-medium) !important;
95+
right: auto;
96+
}
97+
}

0 commit comments

Comments
 (0)