From 67f6074e480fe2b9ad07648a35f0c21864c51b5c Mon Sep 17 00:00:00 2001 From: alphasentaurii Date: Thu, 5 Dec 2024 13:10:24 -0500 Subject: [PATCH] add custom domain, update cpp page, graphviz background white script --- asdf_website/_static/js/custom.js | 8 ++++++ asdf_website/applications/asdf-cpp.rst | 34 +++++++++++++++++++++++++- asdf_website/conf.py | 13 +++++++++- 3 files changed, 53 insertions(+), 2 deletions(-) diff --git a/asdf_website/_static/js/custom.js b/asdf_website/_static/js/custom.js index e69de29..2128881 100644 --- a/asdf_website/_static/js/custom.js +++ b/asdf_website/_static/js/custom.js @@ -0,0 +1,8 @@ +let themeSetting = document.body.dataset.theme; +if ( themeSetting != 'light' ) { + let graphElem = document.getElementsByClassName('graphviz'); + if ( graphElem.length > 1 ) { + graphObj = graphElem[1]; + graphObj.setAttribute("style", "background-color: white;"); + } +} \ No newline at end of file diff --git a/asdf_website/applications/asdf-cpp.rst b/asdf_website/applications/asdf-cpp.rst index 3677d40..f1f09b0 100644 --- a/asdf_website/applications/asdf-cpp.rst +++ b/asdf_website/applications/asdf-cpp.rst @@ -3,4 +3,36 @@ ASDF for C++ ============ -`asdf-cpp `__ is a prototype library implementation of the ASDF Standard in C++. It is not yet feature-complete, but it supports ASDF's core capabilities of storing metadata in YAML and serializing n-dimensional numerical data arrays. +`asdf-cxx `__ is an open-source prototype implementation of the ASDF Standard in C++ authored by `Erik Schnetter `__. Although not yet feature-complete, the library supports ASDF's core capabilities of storing metadata in YAML and serializing n-dimensional numerical data arrays. + + +Installation Requirements +------------------------- + +- C++ 17-capable C++ compiler (tested with `Clang `__ and `GCC `__) +- `cmake `__ +- `pkg-config `__ +- `yaml-cpp `__ + +**Optional libraries for compression and MD5:** + +- `OpenSSL `__ (MD5 checksums) +- `bzip2 `__ (compression) +- `c-blosc `__ (compression) +- `c-blosc2 `__ (compression) +- `lz4 `__ (compression) +- `zlib `__ (compression) +- `zstd `__ (compression) + + +Build Instructions +------------------ + +.. code-block:: bash + + $ git clone https://github.com/eschnett/asdf-cxx + $ cd asdf-cxx + $ cmake -B build -S . + $ cmake --build build + $ ctest --test-dir build + $ cmake --install build diff --git a/asdf_website/conf.py b/asdf_website/conf.py index 1c30012..3605983 100644 --- a/asdf_website/conf.py +++ b/asdf_website/conf.py @@ -31,6 +31,9 @@ # -- General configuration --------------------------------------------------- on_rtd = 'True' + +html_baseurl = "https://asdf-format.org" + # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. @@ -72,7 +75,10 @@ language = "en" # The name of the Pygments (syntax highlighting) style to use. -# pygments_style = "sphinx" +pygments_style = "monokai" + +# NB Dark style pygments is furo-specific at this time +# pygments_dark_style = "monokai" # The reST default role (used for this markup: `text`) to use for all documents. default_role = "ref" @@ -159,6 +165,11 @@ # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. html_show_copyright = True + +html_js_files = [ + 'js/custom.js', +] + # html_context = {"bootswatch_css_custom": ["_static/custom.css"]} intersphinx_disabled_reftypes = ["*"]