add FAQs and a test doc

deepmodeling · Aug 9, 2022 · 3fed2bb · 3fed2bb
1 parent 5c17874
commit 3fed2bb
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -65,6 +65,7 @@ DPGEN's documentation
    :glob:  
 
    Tutorials <https://tutorials.deepmodeling.com/en/latest/Tutorials/DP-GEN/>
+   troubleshooting/index
 
 
 .. _Contribution:

diff --git a/doc/troubleshooting/index.rst b/doc/troubleshooting/index.rst
@@ -0,0 +1,13 @@
+FAQs
+====
+Some frequently asked questions are listed as follows.
+If other unexpected problems occur, you're welcome to contact us for help.
+
+.. _trouble:
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Trouble shooting
+   :glob:
+
+   ./*
diff --git a/doc/troubleshooting/test.md b/doc/troubleshooting/test.md
@@ -0,0 +1,2 @@
+# Hi!
+I just wanna test it.
-Original file line number
+Diff line change
@@ Expand Up / @@ -65,6 +65,7 @@ DPGEN's documentation @@
        :glob:
        Tutorials <https://tutorials.deepmodeling.com/en/latest/Tutorials/DP-GEN/>
+       troubleshooting/index
     .. _Contribution:
@@ Expand Down @@