Merge pull request #311 from ZJUEarthData/web

fix: fix the chaos of showing the subsection of the top 1 docs.
ZJUEarthData · Feb 5, 2024 · d894898 · d894898
2 parents 3a08d0f + 892801d
commit d894898
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 14 deletions.
diff --git a/docs/source/For Developer/Contributing/Code_of_Conduct.md b/docs/source/For Developer/Contributing/Code_of_Conduct.md
@@ -1,4 +1,4 @@
-#  Code of Conduct
+# Code of Conduct
 
 Contents：
 

diff --git a/docs/source/For Developer/Contributing/Contributor.md b/docs/source/For Developer/Contributing/Contributor.md
@@ -1,4 +1,5 @@
 # Contributors
+
 ## Leader:
 + Can He (Sany, National University of Singapore, Singapore)
   Email: [email protected]

diff --git a/docs/source/For User/Contact us/Q&A.md b/docs/source/For User/Contact us/Q&A.md
@@ -1,4 +1,3 @@
-
 # Frequently Asked Questions
 
 **For your reference, we have summarized some problems encountered and solved in the process of development and testing**

diff --git a/docs/source/For User/Contact us/bug_report.md b/docs/source/For User/Contact us/bug_report.md
@@ -1,4 +1,4 @@
-## Bug Reports
+# Bug Reports
 
 If you find <font color=pink>Geochemistry Py</font> does not work well with you, in the meantime, googling error messages cannot help. Please check the Q&A first to see if similar questions have already been posted, and there may already be valid comments. If not, please contact us and send the details of bug. Our experts are willing to solve the problems for you as soon as we can. Here is a toturial posted on Youtube [“Geochemistry π-How to use Github for collaboration and Bug reporting-Sany”](https://www.youtube.com/watch?v=1DWoEsqsfvQ&list=PLy8hNsI55lvh1UHjhVhqNUj3xPdV9sEiM&index=4).
 

diff --git a/docs/source/For User/Installation Manual.md b/docs/source/For User/Installation Manual.md
@@ -1,15 +1,7 @@
-<p style="text-align: center; font-size: 38px; font-weight: bold;">
-
-Installation Manual
-
-</p>
-
-
+# Installation Manual
 
 #### Contents
 
-
-
 1. [Preparation](#Preparation)
 
 2. [Download Geochemistry π](#Download-Geichemistry—π)

diff --git a/docs/source/For User/Model Example/Data_Preprocessing/Data Preprocessing.md b/docs/source/For User/Model Example/Data_Preprocessing/Data Preprocessing.md
@@ -1,8 +1,10 @@
 
 # Data Cleaning & Preprocessing
-  When we are working on data-mining or machine learning projects, the quality of your results highly depends on the quality of input data. As a result, data cleaning and preprocessing becomes an important step to make sure your input data is neat and balanced. Normally, data scientists will spend a large portion of their working time on data cleaning. However, Geochemistrypi can conduct this process automatically for you, and you just need to follow some simple steps.
+
+When we are working on data-mining or machine learning projects, the quality of your results highly depends on the quality of input data. As a result, data cleaning and preprocessing becomes an important step to make sure your input data is neat and balanced. Normally, data scientists will spend a large portion of their working time on data cleaning. However, Geochemistrypi can conduct this process automatically for you, and you just need to follow some simple steps.
 
 Firstly you need to start the geochemistrypi programm via command line instrucitons. Please refer to **Quick Installation** and **Example** to know how to start geochemistrypi. And now we use a classification data file as a sample.
+
 #### Data Schema
 
 In order to utilize the functions provided by our software, your own data set should satisfy:

diff --git a/docs/source/Home/Introduction.md b/docs/source/Home/Introduction.md
@@ -14,6 +14,10 @@
 
 ---
 
+# Introduction
+
+## What it is
+
 Geochemistry π is an **open-sourced highly automated machine learning Python framework** dedicating to build up MLOps level 1 software product for data-driven geochemistry discovery on tabular data.
 
 Core capabilities are:

diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -4,5 +4,5 @@ Contributing
 .. toctree::
    :maxdepth: 3
 
-   Code of Contuct <For Developer/Contributing/Code Specification v2.2.1 - Geochemistry π.md>
+   Code of Contuct <For Developer/Contributing/Code_of_Conduct.md>
    Contributors <For Developer/Contributing/Contributor.md>
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,3 @@

		# Frequently Asked Questions

		For your reference, we have summarized some problems encountered and solved in the process of development and testing
Expand Down