Skip to content

Commit ec4767a

Browse files
committed
Updates docs with proper json syntax
1 parent 0a98107 commit ec4767a

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

docs/options.rst

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,9 @@ source_dirs
8484

8585
.. code-block:: json
8686
87-
"source_dirs": ["./**", "/external/fortran/src"]
87+
{
88+
"source_dirs": ["./**", "/external/fortran/src"]
89+
}
8890
8991
By default all directories under the current project will be recursively parsed
9092
for Fortran sources. Alternatively, one can define a series of directories
@@ -97,7 +99,9 @@ incl_suffixes
9799

98100
.. code-block:: json
99101
100-
"incl_suffixes": [".h", ".FYP"]
102+
{
103+
"incl_suffixes": [".h", ".FYP"]
104+
}
101105
102106
``fortls`` will parse only files with ``incl_suffixes`` extensions found in
103107
``source_dirs``. By default ``incl_suffixes`` are defined as
@@ -112,7 +116,9 @@ excl_suffixes
112116

113117
.. code-block:: json
114118
115-
"excl_suffixes": ["_tmp.f90", "_hdf5.F90"]
119+
{
120+
"excl_suffixes": ["_tmp.f90", "_hdf5.F90"]
121+
}
116122
117123
If certain files or suffixes do not need to be parsed these can be excluded by
118124
deffining ``excl_suffixes``
@@ -130,8 +136,9 @@ its subdirectories from being parsed you should define it like so
130136

131137
.. code-block:: json
132138
133-
"excl_paths": ["exclude_dir/**"]
134-
139+
{
140+
"excl_paths": ["exclude_dir/**"]
141+
}
135142
136143
Preprocessor
137144
############
@@ -141,7 +148,9 @@ pp_suffixes
141148

142149
.. code-block:: json
143150
144-
"pp_suffixes" : [".h", ".F90", ".fpp"]
151+
{
152+
"pp_suffixes" : [".h", ".F90", ".fpp"]
153+
}
145154
146155
By default preprocessor definitions are parsed for all Fortran source files
147156
with uppercase extensions e.g. ``.F90``, ``.F``, ``.F08``, etc.. However, the
@@ -153,7 +162,9 @@ include_dirs
153162

154163
.. code-block:: json
155164
156-
"include_dirs": ["include", "preprocessor", "/usr/include"]
165+
{
166+
"include_dirs": ["include", "preprocessor", "/usr/include"]
167+
}
157168
158169
By default ``fortls`` will scan the project's directories for files with extensions
159170
``PP_SUFFIXES`` to parse for **preprocessor definitions**. However, if the preprocessor
@@ -169,9 +180,11 @@ pp_defs
169180

170181
.. code-block:: json
171182
172-
"pp_defs": {
173-
"HAVE_PETSC": ""
174-
"Mat": "type(tMat)"
183+
{
184+
"pp_defs": {
185+
"HAVE_PETSC": ""
186+
"Mat": "type(tMat)"
187+
}
175188
}
176189
177190
Additional **preprocessor definitions** from what are specified in files found in

0 commit comments

Comments
 (0)