Skip to content

Commit

Permalink
updating first sections
Browse files Browse the repository at this point in the history
removing single quote section.  It is no longer a problem.
  • Loading branch information
lisagoodrich authored Jul 19, 2023
1 parent cc94c7b commit be222e3
Showing 1 changed file with 13 additions and 30 deletions.
43 changes: 13 additions & 30 deletions docs/Contributors_Guide/documentation.rst
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
*************
Documentation
*************
**************************************
Documentation Overview and Conventions
**************************************

Viewing METplus Documentation
=============================
Overview
========

The METplus documentation (beginning with version 3.0) is available
`online <https://metplus.readthedocs.io/>`_.


Doxygen Source Code Documentation
=================================

The source code documentation is coming soon.
`online <https://metplus.readthedocs.io/>`_. 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) <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_.
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.
Expand Down Expand Up @@ -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 <https://stackoverflow.com/questions/17965655/how-to-escape-single-quotes-in-restructuredtext-when-converting-to-html-using-sp>`_.



Sphinx modules
--------------

Expand Down

0 comments on commit be222e3

Please sign in to comment.