docs: Use new logos

roc-streaming · Jul 7, 2024 · 6839b2c · 6839b2c
1 parent 9b3be2f
commit 6839b2c
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-![](docs/images/logo.png)
+![](docs/images/readme_logo.png)
 
 # Roc Toolkit: real-time audio streaming
 

diff --git a/docs/SConscript b/docs/SConscript
@@ -25,7 +25,8 @@ if GetOption('enable_doxygen'):
             build_dir='#build/docs/internal_modules',
             config='#src/internal_modules/Doxyfile',
             sources=(doc_env.GlobRecursive('#src/internal_modules', ['*.h', '*.dox']) +
-                doc_env.GlobRecursive('#docs/images', ['*'])),
+                     doc_env.GlobRecursive('#docs/images', ['*']) +
+                     [doc_env.File('#docs/doxygen_extras.css')]),
             werror=GetOption('enable_werror')),
         doc_env.Doxygen(
             build_dir='#build/docs/public_api',

diff --git a/docs/doxygen_extras.css b/docs/doxygen_extras.css
@@ -0,0 +1,7 @@
+/* roc css overrides */
+
+#projectlogo img {
+    width: 60px;
+    height: 60px;
+    padding: 5px;
+}
diff --git a/docs/sphinx/_static/roc.css → docs/sphinx/_static/sphinx_extras.css b/docs/sphinx/_static/roc.css → docs/sphinx/_static/sphinx_extras.css
@@ -72,3 +72,8 @@ table.align-default {
 table.align-center {
     margin-left: 0;
 }
+
+.logo {
+    width: 180px;
+    height: 90px;
+}
diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py
@@ -60,7 +60,7 @@ def get_version():
 
 html_theme = 'nature'
 
-html_logo = '../images/logo80.png'
+html_logo = '../images/sphinx_logo.png'
 
 html_sidebars = {
    '**': ['globaltoc.html', 'searchbox.html'],
@@ -69,7 +69,7 @@ def get_version():
 html_static_path = ['_static']
 
 html_css_files = [
-    'roc.css',
+    'sphinx_extras.css',
 ]
 
 html_js_files = [

diff --git a/src/internal_modules/Doxyfile b/src/internal_modules/Doxyfile
@@ -1,6 +1,6 @@
 PROJECT_NAME            = "Roc Toolkit internal modules"
 PROJECT_BRIEF           = "Roc Toolkit: real-time audio streaming"
-PROJECT_LOGO            = ../../docs/images/icon80.png
+PROJECT_LOGO            = ../../docs/images/doxygen_logo.png
 
 QUIET                   = YES
 RECURSIVE               = YES
@@ -13,7 +13,6 @@ EXCLUDE                 =                         \
     roc_core/target_posix/roc_core/cpu_traits.h
 
 FULL_PATH_NAMES         = YES
-SOURCE_BROWSER          = YES
 
 JAVADOC_AUTOBRIEF       = YES
 QT_AUTOBRIEF            = YES
@@ -46,14 +45,18 @@ PREDEFINED              =      \
 
 OUTPUT_DIRECTORY        = ../../build/docs/internal_modules
 HTML_OUTPUT             = ../../../docs/html/doxygen
-
-GENERATE_LATEX          = NO
-DOT_GRAPH_MAX_NODES     = 1000
+HTML_EXTRA_STYLESHEET   = ../../docs/doxygen_extras.css
 
 HTML_DYNAMIC_SECTIONS   = NO
 DISABLE_INDEX           = NO
 GENERATE_TREEVIEW       = YES
 SEARCHENGINE            = YES
+SOURCE_BROWSER          = YES
+DOT_GRAPH_MAX_NODES     = 1000
+
+GENERATE_XML            = NO
+GENERATE_HTML           = YES
+GENERATE_LATEX          = NO
 
 OUTPUT_LANGUAGE         = English
 DOXYFILE_ENCODING       = UTF-8
diff --git a/src/public_api/Doxyfile b/src/public_api/Doxyfile
@@ -31,6 +31,7 @@ WARN_NO_PARAMDOC        = NO
 ENABLE_PREPROCESSING    = YES
 MACRO_EXPANSION         = YES
 EXPAND_ONLY_PREDEF      = YES
+
 PREDEFINED              = ROC_API= ROC_DOXYGEN=
 
 OUTPUT_DIRECTORY        = ../../build/docs/public_api