From be222e32aed4caf678e7c5e786a35a63764a221f Mon Sep 17 00:00:00 2001 From: lisagoodrich <33230218+lisagoodrich@users.noreply.github.com> Date: Wed, 19 Jul 2023 15:50:09 -0600 Subject: [PATCH] updating first sections removing single quote section. It is no longer a problem. --- docs/Contributors_Guide/documentation.rst | 43 +++++++---------------- 1 file changed, 13 insertions(+), 30 deletions(-) diff --git a/docs/Contributors_Guide/documentation.rst b/docs/Contributors_Guide/documentation.rst index 0c43161e1f..0b0f94fd2e 100644 --- a/docs/Contributors_Guide/documentation.rst +++ b/docs/Contributors_Guide/documentation.rst @@ -1,22 +1,20 @@ -************* -Documentation -************* +************************************** +Documentation Overview and Conventions +************************************** -Viewing METplus Documentation -============================= +Overview +======== The METplus documentation (beginning with version 3.0) is available -`online `_. - - -Doxygen Source Code Documentation -================================= - -The source code documentation is coming soon. +`online `_. The majority of the documentation +is created using the Sphinx documentation generator tool, which was originally +created for Python documentation. The documentation is created using +'reStructuredText (RST) `_. +This link provides a brief introduction to RST concepts and syntax, intended +to give authors enough information to create and modify the documents productively. - -Documentation Overview and Conventions -====================================== +Conventions +=========== The majority of the documentation is created using the Sphinx documentation generator tool, which was originally created for Python documentation. @@ -664,21 +662,6 @@ This will show up as a broken link in the documentation. To keep this from happening put a backwards slash in front of the underscore. “FNN\\_” -‘single quotes’ -^^^^^^^^^^^^^^^ -Single quotes tend to convert to a broken link. To stop this from happening, -use backward slashes \ before and after the single quotes. -Example:: - - \’\single quotes\’\ - -It will look like this on the web: \’\single quotes\’\ vs 'single quotes' - -For more information, -`this page was helpful `_. - - - Sphinx modules --------------