From a2224bb4552a4b949686abc4d8c0373bff93fa35 Mon Sep 17 00:00:00 2001 From: Lorraine Hwang Date: Sat, 1 Jun 2024 14:37:47 -0600 Subject: [PATCH 1/2] Update documentation_style_guide.md minor fixes --- .../documentation_style_guide.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/sphinx/developer_manual/contributing_to_the_documentation/documentation_style_guide.md b/doc/sphinx/developer_manual/contributing_to_the_documentation/documentation_style_guide.md index 1af6c1c26..76bbeb21c 100644 --- a/doc/sphinx/developer_manual/contributing_to_the_documentation/documentation_style_guide.md +++ b/doc/sphinx/developer_manual/contributing_to_the_documentation/documentation_style_guide.md @@ -2,7 +2,7 @@ Documentation style guide ========================= -Not only are there many ways to style the documents, there are also many ways with sphinx to reach the same output. To attempt to unify the style of the documentation and the documentation code, this page contains some general styling recommendations. +Not only are there many ways to style the documents, there are also many ways with Sphinx to reach the same output. To attempt to unify the style of the documentation and the documentation code, this page contains some general styling recommendations. # Page titles @@ -14,7 +14,7 @@ The page label should always be a path, separated by colons (`:`) in the followi # Including advanced elements -When possible, the use of colons (`:`) should be preferred over the use of grave accents (\`) when creating advanced elements such as todo notes, figures, code blocks, or tables. This means that: +When possible, the use of colons (`:`) should be preferred over the use of grave accents (\`) when creating advanced elements such as todo notes, figures, code blocks or tables. This means that: ::::{code-block} md :::{note} @@ -32,11 +32,11 @@ My Note # Including World Builder files -When including a world builder file, it is important to be able to focus on the parts which are important, while also enabling the reader to see the surrounding context and the whole file. Furthermore, the user should have the capability to run the models themselves and get the same output as shown. To standardize this the following structure is strongly encouraged. +When including a World bbilder file, it is important to be able to focus on the parts which are important, while also enabling the reader to see the surrounding context and the whole file. Furthermore, the user should have the capability to run the models themselves and get the same output as shown. To standardize this the following structure is strongly encouraged. -1. The world builder file and a corresponding grid file need to be stored separately, either in the cookbook, or in the _static directory. -2. The use of a tab-set with a tab with important lines and a tab with the full world builder file, highlighting important lines. -3. Adding at least a link to the world builder file and a grid file to visualize it, preferably also a link to a `.pvtu` file which allows to get the same output as the figure, if present. +1. The World Builder file and a corresponding grid file need to be stored separately, either in the cookbook, or in the _static directory. +2. The use of a tab-set with a tab with important lines and a tab with the full World Builder file, highlighting important lines. +3. Adding at least a link to the World Builder file and a grid file to visualize it, preferably also a link to a `.pvtu` file which allows to get the same output as the figure, if present. 4. Add a figure of the output. Below is an example code block. From faab66872ac30f42b254746de752156ba784c771 Mon Sep 17 00:00:00 2001 From: Menno Fraters Date: Thu, 1 Aug 2024 09:52:27 +0000 Subject: [PATCH 2/2] Update doc/sphinx/developer_manual/contributing_to_the_documentation/documentation_style_guide.md --- .../documentation_style_guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx/developer_manual/contributing_to_the_documentation/documentation_style_guide.md b/doc/sphinx/developer_manual/contributing_to_the_documentation/documentation_style_guide.md index 76bbeb21c..8ff0a6cb2 100644 --- a/doc/sphinx/developer_manual/contributing_to_the_documentation/documentation_style_guide.md +++ b/doc/sphinx/developer_manual/contributing_to_the_documentation/documentation_style_guide.md @@ -32,7 +32,7 @@ My Note # Including World Builder files -When including a World bbilder file, it is important to be able to focus on the parts which are important, while also enabling the reader to see the surrounding context and the whole file. Furthermore, the user should have the capability to run the models themselves and get the same output as shown. To standardize this the following structure is strongly encouraged. +When including a World Builder file, it is important to be able to focus on the parts which are important, while also enabling the reader to see the surrounding context and the whole file. Furthermore, the user should have the capability to run the models themselves and get the same output as shown. To standardize this the following structure is strongly encouraged. 1. The World Builder file and a corresponding grid file need to be stored separately, either in the cookbook, or in the _static directory. 2. The use of a tab-set with a tab with important lines and a tab with the full World Builder file, highlighting important lines.