Skip to content

Commit

Permalink
add custom domain, update cpp page, graphviz background white script
Browse files Browse the repository at this point in the history
  • Loading branch information
alphasentaurii committed Dec 5, 2024
1 parent e21eaf8 commit 67f6074
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 2 deletions.
8 changes: 8 additions & 0 deletions asdf_website/_static/js/custom.js
Original file line number Diff line number Diff line change
@@ -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;");
}
}
34 changes: 33 additions & 1 deletion asdf_website/applications/asdf-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,36 @@
ASDF for C++
============

`asdf-cpp <https://github.com/asdf-format/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 <https://github.com/eschnett/asdf-cxx>`__ is an open-source prototype implementation of the ASDF Standard in C++ authored by `Erik Schnetter <https://github.com/eschnett>`__. 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 <https://clang.llvm.org/>`__ and `GCC <https://gcc.gnu.org/>`__)
- `cmake <https://cmake.org/>`__
- `pkg-config <https://www.freedesktop.org/wiki/Software/pkg-config/>`__
- `yaml-cpp <https://github.com/jbeder/yaml-cpp>`__

**Optional libraries for compression and MD5:**

- `OpenSSL <https://www.openssl.org/>`__ (MD5 checksums)
- `bzip2 <http://bzip.org/>`__ (compression)
- `c-blosc <https://www.blosc.org/>`__ (compression)
- `c-blosc2 <https://www.blosc.org/>`__ (compression)
- `lz4 <https://lz4.org/>`__ (compression)
- `zlib <http://zlib.net/>`__ (compression)
- `zstd <https://github.com/facebook/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
13 changes: 12 additions & 1 deletion asdf_website/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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 = ["*"]
Expand Down

0 comments on commit 67f6074

Please sign in to comment.