diff --git a/brassaia/index/src/index_intf.ml b/brassaia/index/src/index_intf.ml index 0ed8d11e64c6b5e2feff0ae5c25a25bda81a44da..737db81c037e8f841ff62fcb6fd9922f9014ccd7 100644 --- a/brassaia/index/src/index_intf.ml +++ b/brassaia/index/src/index_intf.ml @@ -248,8 +248,8 @@ module type Index = sig end module Value : sig - (** The input of {!Make} for values. The same requirements as for {!Key} - apply. *) + (** The input of {!Make} for values. The same requirements as for + {!module-Key} apply. *) module type S = sig include Value (** @inline *) diff --git a/docs/README.rst b/docs/README.rst index 18728f7ed5fc0d47d1782914f3e6fd69aecae5a0..60257a19076d01bb704e525d6bbbf33cfba2bc79 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -61,9 +61,7 @@ generated HTML pages are put in ``_build//_doc``. It creates one sub-directory per public library and generates an ``index.html`` file in each sub-directory. -The documentation is not installed on the system by Octez. It is meant to be -read locally while developing and then published on the www when releasing -packages. +The documentation is published online at :doc:`api/api-inline`. Writing documentation ===================== diff --git a/docs/developer/guidelines.rst b/docs/developer/guidelines.rst index 00f2e0328031efd5ed297fb4d42c77864825f567..6739e503662b5236da91db5ddf7c07ac84f08e59 100644 --- a/docs/developer/guidelines.rst +++ b/docs/developer/guidelines.rst @@ -167,6 +167,8 @@ Here are a few tips and guidelines on using docstrings. - Docstrings in ``.mli`` and ``.ml`` files are handled the same, so do not omit documenting the interfaces in the latter files. For more information on using docstrings, see the ``odoc`` `documentation for library authors `__. +In particular, it contains a `cheatsheet `__ that may be useful. + Docstrings errors """""""""""""""""