Minor patch for #142

- Remove the page tag in README.md
- Detect formula in option description

ref #146

README.md

@@ -1,4 +1,4 @@
-# Overview {#overview}
+# Overview
 
 [![Documentation](https://github.com/reverendbedford/neml2/actions/workflows/build_docs.yml/badge.svg?branch=main)](https://reverendbedford.github.io/neml2/) [![tests](https://github.com/reverendbedford/neml2/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/reverendbedford/neml2/actions/workflows/tests.yml)
 

scripts/syntax_to_md.py

@@ -68,7 +68,7 @@ def get_sections(syntax):
 
     with open(logfile, "w") as log:
         missing = 0
-        log.write("## Missing syntax\n")
+        log.write("## Syntax check\n\n")
         sections = get_sections(syntax)
         for section in sections:
             with open((outdir / section.lower()).with_suffix(".md"), "w") as stream:
@@ -120,7 +120,7 @@ def get_sections(syntax):
                             )
                             missing += 1
                             log.write(
-                                "    * '{}'.'{}' is missing option description\n".format(
+                                "  * '{}/{}' is missing option description\n".format(
                                     input_type, param_name
                                 )
                             )
@@ -130,6 +130,12 @@ def get_sections(syntax):
                                     param_name, info["doc"]
                                 )
                             )
+                            if "\\f" in info["doc"]:
+                                log.write(
+                                    "  * '{}/{}' has formula in its option description\n".format(
+                                        input_type, param_name
+                                    )
+                                )
                         stream.write("  - <u>Type</u>: {}\n".format(param_type))
                         if param_value:
                             stream.write("  - <u>Default</u>: {}\n".format(param_value))
@@ -140,4 +146,4 @@ def get_sections(syntax):
                     )
 
         if missing == 0:
-            log.write("Nothing, good job! :purple_heart:")
+            log.write("No syntax error, good job! :purple_heart:")