]> git.proxmox.com Git - ceph.git/blobdiff - ceph/doc/dev/documenting.rst
update source to Ceph Pacific 16.2.2
[ceph.git] / ceph / doc / dev / documenting.rst
index 01984c2561da148bd65dff3d04badc5255bd7342..42bd56d06fed5754d55090445efaf1c1d5d810d1 100644 (file)
@@ -51,6 +51,14 @@ functions should be grouped into logical categories. The `librados C
 API`_ provides a complete example. It is pulled into Sphinx by
 `librados.rst`_, which is rendered at :doc:`/rados/api/librados`.
 
+To generate the doxygen documentation in HTML format use:
+
+::
+
+   # make doxygen
+
+HTML output will be under: ``build-doc/doxygen/html`` 
+
 .. _`librados C API`: https://github.com/ceph/ceph/blob/master/src/include/rados/librados.h
 .. _`librados.rst`: https://github.com/ceph/ceph/raw/master/doc/rados/api/librados.rst