InfiniBand Chinese Manual

This repository contains a Sphinx-based documentation for the InfiniBand, as well as corresponding code examples.

Installation

https://docs.nvidia.com/networking/display/mlnxofedv531001

Build the documentation

To build and/or contribute to this documentation, you must have a Sphinx and a few related extensions installed. These can be installed as follows using Python's pip.

pip install sphinx
pip install sphinx-rtd-theme
pip install sphinx_copybutton
pip install recommonmark
pip install breathe
pip install jieba

Alternately, those required packages may also be avaible in your platform's primary package manager. For example, in Ubuntu 23.04 you could do the following instead of using pip:

sudo apt install python3-breathe python3-recommonmark python3-sphinx-copybutton python3-sphinx-rtd-theme python3-jieba

You must also install the doxygen documentation system. This is likely avaible in your platform's primary package manager. For example on Ubuntu:

sudo apt install doxygen

Once you have these dependencies installed, clone this repository and cd into it. You can change the documentation by editing the files in the source subdirectory (these files use the .rst format). You can build the documentation using the following command.

cd docs
make html

Build the code examples

reSturedText tips

1. Sphinx, reStructuredText show/hide code snippets

2. Controlling the Width of a Table With Read-the-Docs

3. Sections

4. Sections

5. 中文配置问题

6. 在 WSL 上显示 html 页面：

   explorer.exe index.html