From fa1dc8f4ecc0ce10e27cc6a7f02370f1166e82bd Mon Sep 17 00:00:00 2001 From: Alejandro Saucedo Date: Mon, 25 Jan 2021 08:35:27 +0000 Subject: [PATCH] Added further documentation updates --- docs/CMakeLists.txt | 5 +++++ docs/assets/custom.css | 3 +++ docs/conf.py | 27 ++++++++++++++++++++++----- docs/index.rst | 19 ++++++++++++++++--- 4 files changed, 46 insertions(+), 8 deletions(-) create mode 100644 docs/assets/custom.css diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 47c35bdc1..c59635275 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -66,5 +66,10 @@ add_custom_target(gendocsall ALL -E copy ${PROJECT_SOURCE_DIR}/CNAME ${SPHINX_BUILD}/CNAME +# Copy the custom asset folder + COMMAND ${CMAKE_COMMAND} + -E copy_directory + ${PROJECT_SOURCE_DIR}/docs/assets/ + ${SPHINX_BUILD}/_static/ DEPENDS gensphinx) diff --git a/docs/assets/custom.css b/docs/assets/custom.css new file mode 100644 index 000000000..de1b45027 --- /dev/null +++ b/docs/assets/custom.css @@ -0,0 +1,3 @@ +.md-nav__title--site { + display: none; +} diff --git a/docs/conf.py b/docs/conf.py index 2d43bc055..2ede3b7ff 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,9 +19,11 @@ import sys import os import kp +import sphinx_material project = 'Vulkan Kompute' copyright = '2020, The Institute for Ethical AI & Machine Learning' +html_title = "Vulkan Kompute Documentation (Python & C++)" author = 'Alejandro Saucedo' # The full version, including alpha/beta/rc tags @@ -67,20 +69,31 @@ html_theme = 'sphinx_material' if html_theme == 'sphinx_material': html_theme_options = { - 'nav_title': 'Vulkan Kompute', - #'google_analytics_account': 'UA-XXXXX', - #'base_url': 'https://project.github.io/project', + 'google_analytics_account': 'G-F9LD9HL8LW', + 'base_url': 'https://kompute.cc', 'color_primary': 'red', 'color_accent': 'light-blue', 'repo_url': 'https://github.com/EthicalML/vulkan-kompute/', 'repo_name': 'Vulkan Kompute', - 'globaltoc_depth': 3, + 'globaltoc_depth': 2, 'globaltoc_collapse': False, 'globaltoc_includehidden': False, + "repo_type": "github", + "nav_links": [ + { + "href": "https://github.com/EthicalML/vulkan-kompute/", + "internal": False, + "title": "Kompute Repo", + }, + ] } + extensions.append("sphinx_material") + html_theme_path = sphinx_material.html_theme_path() + html_context = sphinx_material.get_html_context() + html_sidebars = { - "**": ["logo-text.html", "globaltoc.html", "searchbox.html"] + "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"] } # Add any paths that contain custom static files (such as style sheets) here, @@ -88,4 +101,8 @@ html_sidebars = { # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] +html_css_files = [ + 'custom.css', +] + diff --git a/docs/index.rst b/docs/index.rst index 0f256bbc4..37fda6d30 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,18 +8,31 @@ Index -------- .. toctree:: - :maxdepth: 2 + :maxdepth: 0 + + Documentation Home + +.. toctree:: :titlesonly: + :caption: C++ Documentation: C++ Simple & Advanced Examples C++ Memory Management Principles C++ Build System Deep Dive C++ Converting GLSL/HLSL Shaders to Cpp Headers C++ Class Documentation & Reference - ---- + +.. toctree:: + :titlesonly: + :caption: Python Documentation: + Python Package Overview & Examples Python Class Documentation & Reference - ---- + +.. toctree:: + :titlesonly: + :caption: Concepts & Deep Dives: + CI, Docker Images & Tests Asynchronous & Parallel Operations Mobile App Integration (Android)