diff --git a/docs/conf.py b/docs/conf.py index f912d6fff22c221f57a65958109141f037377d5f..4c3ec5a0bd5658504689ee06ed69cf95451ef12f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -134,6 +134,7 @@ html_theme_options = { 'use_issues_button': True, 'use_download_button': False, 'use_fullscreen_button': True, + 'use_source_button': True, } html_theme_options["analytics"] = { @@ -248,6 +249,7 @@ linkcheck_ignore = [ r'^http(s)?://localhost:\d+/?', r'^https://grafana\.nomadic-labs\.cloud/', r'^https://github\.com/jsonnet-bundler/jsonnet-bundler/', + r'https://github\.com/thierry-martinez/stdcompat/issues/13', # local files, e.g. ../api/api-inline.html#*', \.\./CHANGES.html#version-* # (interpreted by linkcheck as external links, generating false positives) r'^\.\./', diff --git a/docs/developer/guidelines.rst b/docs/developer/guidelines.rst index 9a44ca20514dd624f6435e6c234ce10e4c50385d..56374ff609d35e11ebaf81b602351b8f4bb5c6c0 100644 --- a/docs/developer/guidelines.rst +++ b/docs/developer/guidelines.rst @@ -166,8 +166,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. +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 @@ -319,7 +319,7 @@ Fortunately, a few techniques may greatly increase the maintainability of commen * For instance, an externally-visble module exporting part of the functionality of some internal module(s) should describe each exported element, because users may not look to the internal module(s); but the internal modules should also describe their interface for their own users and maintainers. In such cases, duplication may be avoided by choosing a single place for the comments, and using cross-references to it wherever needed. - Fortunately, Odoc provides `such cross-references `__ and checks for each reference that the target element exists, ensuring they do not get stale when code is moved or suppressed. + Fortunately, Odoc provides `such cross-references `__ and checks for each reference that the target element exists, ensuring they do not get stale when code is moved or suppressed. * In other cases, the documentation needed near some piece of code is already available outside the code. For instance, a user-visible client command or node RPC should not duplicate explanations in the user reference. diff --git a/docs/index.rst b/docs/index.rst index aff55816e80ea6391245d6e9a73179b8a636a6b1..ade7a45b97134b7d92ab35cf070a3cb406f5b003 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -147,6 +147,7 @@ Platform developers are also provided reference materials for internal APIs of O
+You may also access this whole documentation as a single `text file `__. .. toctree:: :maxdepth: 2 diff --git a/docs/releases/version-21.rst b/docs/releases/version-21.rst index e2d1d41776756627178b7081e4606844f4d1b5dd..26a44a01240d2680013d6020e8570db3b0e135d7 100644 --- a/docs/releases/version-21.rst +++ b/docs/releases/version-21.rst @@ -168,7 +168,7 @@ Check :ref:`the documentation ` for more details. Changelog --------- -- `Version 21.3 <../CHANGES.html#version-21-2>`_ +- `Version 21.3 <../CHANGES.html#version-21-3>`_ - `Version 21.2 <../CHANGES.html#version-21-2>`_ - `Version 21.1 <../CHANGES.html#version-21-1>`_ - `Version 21.0 <../CHANGES.html#version-21-0>`_ diff --git a/docs/shell/dal_run.rst b/docs/shell/dal_run.rst index d0b43f55f161a8add2ce738585ea931c5027a38a..d6ffe6c028e753406bc697f46647690a1b8e34d4 100644 --- a/docs/shell/dal_run.rst +++ b/docs/shell/dal_run.rst @@ -21,6 +21,8 @@ If the ``octez-node`` binary was not started with the ``--network `` ar Running the DAL node -------------------- +Before anything else, make sure your machine satisfies the hardware requirements at :doc:`dal_node`. + Follow these steps to run a DAL node along with a layer 1 node and a baker. #. **If** you plan to run the DAL node in **operator or observer** :ref:`profiles `, install the DAL trusted setup as described in section :ref:`setup_dal_crypto_params` (**NB:** just that section, not the rest of the page such as compiling sources, etc.).