Dockerfile.docs

# Copyright 2022-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#  * Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  * Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#  * Neither the name of NVIDIA CORPORATION nor the names of its
#    contributors may be used to endorse or promote products derived
#    from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

FROM ubuntu:24.04

# various documentation dependencies
RUN apt-get update -q=2 \
    && apt-get install -y --no-install-recommends \
        build-essential \
        curl \
        doxygen \
        git \
        git-lfs \
        pandoc \
        python3-dev \
        python3-pip \
        ssh \
        unzip \
        wget \
    && rm -rf /var/lib/apt/lists/*

# install protobuf
RUN wget https://github.com/google/protobuf/releases/download/v3.6.1/protoc-3.6.1-linux-x86_64.zip -O /tmp/proto.zip \
    && unzip /tmp/proto.zip -d /usr/local \
    && rm /tmp/proto.zip

# install pseudomuto/protoc-gen-doc
RUN wget https://github.com/pseudomuto/protoc-gen-doc/releases/download/v1.3.2/protoc-gen-doc-1.3.2.linux-amd64.go1.12.6.tar.gz -O /tmp/protoc-gen-doc.tar.gz \
    && tar -xvf /tmp/protoc-gen-doc.tar.gz --strip-components=1 -C /usr/local/bin/ \
    && rm /tmp/protoc-gen-doc.tar.gz

# install sphinx et al
ENV PIP_BREAK_SYSTEM_PACKAGES=1
RUN pip3 install \
      ablog \
      attrs  \
      breathe \
      docutils \
      exhale \
      github-slugger \
      httplib2 \
      ipython \
      myst-nb \
      nbclient \
      nbsphinx \
      rst-to-myst \
      sphinx==5.0.0 \
      sphinx-book-theme \
      sphinx-copybutton \
      sphinx-design \
      sphinx-prompt \
      sphinx-sitemap \
      sphinx-tabs \
      sphinxcontrib-bibtex

RUN pip3 install \
      --extra-index-url https://pypi.nvidia.com \
      nvidia-sphinx-theme \
      sphinx==7.4.7

RUN curl -fL https://install-cli.jfrog.io | sh

RUN git config --global --add safe.directory "*"

# Set visitor script to be included on every HTML page
ENV VISITS_COUNTING_SCRIPT="//assets.adobedtm.com/b92787824f2e0e9b68dc2e993f9bd995339fe417/satelliteLib-7ba51e58dc61bcb0e9311aadd02a0108ab24cc6c.js"