Merge pull request #1077 from ocefpaf/use_readme_as_docs

Use README.md as quickintro
ioos · May 22, 2024 · b639de2 · b639de2
2 parents aaeab34 + 6a006e4
commit b639de2
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -101,7 +101,7 @@ The computer-readable name field controls how Results are aggregated together -
 it is possible to *group* Results together via the name property.
 Grouped results will only add up to a single top-level entry.
 
-See the [Development](//github.com/ioos/compliance-checker/wiki/Development) wiki page for more details on implementation.
+See the [Development](https://github.com/ioos/compliance-checker/wiki/Development) wiki page for more details on implementation.
 
 ## Installation
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -165,8 +165,3 @@
         "Miscellaneous",
     ),
 ]
-
-linkcheck_ignore = [
-    # TODO: check again in the future
-    r"https://mmisw.org/ont/ioos/platform",  # 2023-09-05 site non-responsive
-]
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,7 +7,7 @@ Python tool to check your datasets against compliance standards.
    :maxdepth: 3
    :caption: Contents:
 
-   quickintro
+   readme_link
    compliance_checker_api
    faq
    development

diff --git a/docs/source/readme_link.md b/docs/source/readme_link.md
@@ -0,0 +1,2 @@
+```{include} ../../README.md
+```