Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
CMakeLists.txt
CMakeLists.txt
 
 
Doxyfile
Doxyfile
 
 
README.md
README.md
 
 
api.rst
api.rst
 
 
cancellation.rst
cancellation.rst
 
 
channels.rst
channels.rst
 
 
commons.rst
commons.rst
 
 
conf.py
conf.py
 
 
config.rst
config.rst
 
 
error_handling.rst
error_handling.rst
 
 
examples.rst
examples.rst
 
 
ext.rst
ext.rst
 
 
genindex.rst
genindex.rst
 
 
index.rst
index.rst
 
 
interop.rst
interop.rst
 
 
keyexpr.rst
keyexpr.rst
 
 
matching.rst
matching.rst
 
 
publish_subscribe.rst
publish_subscribe.rst
 
 
pubsub.rst
pubsub.rst
 
 
query_reply.rst
query_reply.rst
 
 
queryable.rst
queryable.rst
 
 
requirements.txt
requirements.txt
 
 
scouting.rst
scouting.rst
 
 
session.rst
session.rst
 
 
session_ex.rst
session_ex.rst
 
 
shared_memory.rst
shared_memory.rst
 
 

README.md

Building the documentation

Install tools

  • Ubuntu

    sudo apt install doxygen

  • MacOS

    brew install doxygen
pip3 install sphinx
pip3 install breathe
pip3 install sphinx-rtd-theme

Build documentation locally

git clone https://github.com/eclipse-zenoh/zenoh-cpp.git
mkdir build
cmake -Szenoh-cpp -Bbuild

the output should be

...
-- Found Doxygen: /usr/bin/doxygen (found version "1.9.1") found components: doxygen missing components: dot
-- Found Sphinx: /home/username/.local/bin/sphinx-build  
...

or something like this. If doxygen or sphinx are not found, check first step. If everything is ok, build the documentation with this command:

cmake --build build --target docs

If everything is ok, the output is

...
See read-the-docs html in /username/build/docs/docs/sphinx/index.html
...