From df35679e1ca5ac68ac45900f998803d9497d393c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=98KeranLi=E2=80=99?= <‘keranli98@outlook.com’>
Date: Tue, 5 Sep 2023 15:35:25 +0800
Subject: [PATCH 1/5] docs: Add a new doc about how to install Sphinx and how
to fastly get started.
---
docs/source/For Developer/Sphinx introduction.md | 0
1 file changed, 0 insertions(+), 0 deletions(-)
create mode 100644 docs/source/For Developer/Sphinx introduction.md
diff --git a/docs/source/For Developer/Sphinx introduction.md b/docs/source/For Developer/Sphinx introduction.md
new file mode 100644
index 00000000..e69de29b
From d292d05588cfeb4121550177cb578cc75686cede Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=98KeranLi=E2=80=99?= <‘keranli98@outlook.com’>
Date: Thu, 7 Sep 2023 20:46:48 +0800
Subject: [PATCH 2/5] docs: Add a new doc about how to install Sphinx and how
to fastly get started.
---
.../For Developer/Sphinx introduction.md | 69 +++++++++++++++++++
1 file changed, 69 insertions(+)
diff --git a/docs/source/For Developer/Sphinx introduction.md b/docs/source/For Developer/Sphinx introduction.md
index e69de29b..107228e5 100644
--- a/docs/source/For Developer/Sphinx introduction.md
+++ b/docs/source/For Developer/Sphinx introduction.md
@@ -0,0 +1,69 @@
+## Brief Introduction of Sphinx
+
+Sphinx is written in Python and supports Python 3.9+. It builds upon the shoulders of many third-party libraries such as Docutils and Jinja, which are installed when Sphinx is installed.
+
+Sphinx is an amazing tool for writing beautiful documentation. Originally created for the documentation of the Python programming language, it is now popular across numerous developer communities. Most major Python libraries are documented with Sphinx, e.g. NumPy, SciPy, Scikit-Learn, Matplotlib, Django.
+
+## Install by PyPi
+
+For Mac, Window and Linux systems, the most convenient way to install the ***Sphinx*** package is the **Pypi**. The first step is to enter the **geochemistrypi** file and activate the virtual envirnment by:
+
+```None
+cd geochemistry
+conda activate your_env # Conda with Vscode is the most recommended way
+```
+
+*In Windows/CMD, the operation is:*
+
+ 
+
+*In Windows/Powershell, the operation is:*
+
+
+
+After these preparations, we just need to use ***pip*** to finish the installation via:
+
+```None
+pip install -U sphinx
+```
+
+*In Windows/CMD, the Installation operation is:*
+
+ 
+
+ *In Windows/Powershell, the Installation operation is:*
+
+ 
+
+ ## Fast start of the ***Sphinx***
+
+ The ***Sphinx*** ia a convenient tool for documentations in the projects managemnet. From the *[Getting start](https://www.sphinx-doc.org/en/master/tutorial/getting-started.html)* of the official *[Sphinx documentations](https://www.sphinx-doc.org/en/master/index.html)*, we'd better to set a *README.rst* file in a project like:
+
+
+ 
+
+
+This time I just make a trail docs file. In fact, in a real project, we must write down the descriptions of the project.
+
+In addition, the *[Creating the documentation layout](https://www.sphinx-doc.org/en/master/tutorial/getting-started.html)* is also useful to set up a layout. The specific code is just:
+
+```None
+sphinx-quickstart docs
+```
+
+*In this doc, the consequent screenshots are gained on the Poweshell/Windows platform. The fast layout would be like:*
+
+
+
+As you can see, after you write down the commands, some Chinese reflects are shown in the screen. The root can be set as you wish.
+
+*Then several parameters can be set in the Terminal:*
+
+
+
+*Congratulations！Now you can start write in the index.rst file:*
+
+
+
+------------------------------------------------------------------------------------
+Summary log@2023/09-05@KeranLi: In this cycle, I started to use ***Sphinx*** to manage documentations. I just learned how to install and quick-start. So many details are still waiting for exploring.
From eb5f27e64e0dba4bc3f6b5ce7d8d0cdd08adbeb9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=98KeranLi=E2=80=99?= <‘keranli98@outlook.com’>
Date: Wed, 18 Oct 2023 22:12:48 +0800
Subject: [PATCH 3/5] docs: Add a new doc about how to install Sphinx and how
to fastly get started.
---
.../For Developer/Quick Start of Sphinx.md | 69 +++++++++++++++++++
.../For Developer/Sphinix Guiding Book.md | 69 +++++++++++++++++++
2 files changed, 138 insertions(+)
create mode 100644 docs/source/For Developer/Quick Start of Sphinx.md
create mode 100644 docs/source/For Developer/Sphinix Guiding Book.md
diff --git a/docs/source/For Developer/Quick Start of Sphinx.md b/docs/source/For Developer/Quick Start of Sphinx.md
new file mode 100644
index 00000000..32f38406
--- /dev/null
+++ b/docs/source/For Developer/Quick Start of Sphinx.md
@@ -0,0 +1,69 @@
+## Brief Introduction of Sphinx
+
+Sphinx is written in Python and supports Python 3.9+. It builds upon the shoulders of many third-party libraries such as Docutils and Jinja, which are installed when Sphinx is installed.
+
+Sphinx is an amazing tool for writing beautiful documentation. Originally created for the documentation of the Python programming language, it is now popular across numerous developer communities. Most major Python libraries are documented with Sphinx, e.g. NumPy, SciPy, Scikit-Learn, Matplotlib, Django.
+
+## Install by PyPi
+
+For Mac, Window and Linux systems, the most convenient way to install the ***Sphinx*** package is the **Pypi**. The first step is to enter the **geochemistrypi** file and activate the virtual envirnment by:
+
+```None
+cd geochemistry
+conda activate your_env # Conda with Vscode is the most recommended way
+```
+
+*In Windows/CMD, the operation is:*
+
+
+
+*In Windows/Powershell, the operation is:*
+
+
+
+After these preparations, we just need to use ***pip*** to finish the installation via:
+
+```None
+pip install -U sphinx
+```
+
+*In Windows/CMD, the Installation operation is:*
+
+
+
+ *In Windows/Powershell, the Installation operation is:*
+
+
+
+ ## Fast start of the ***Sphinx***
+
+ The ***Sphinx*** ia a convenient tool for documentations in the projects managemnet. From the *[Getting start](https://www.sphinx-doc.org/en/master/tutorial/getting-started.html)* of the official ***[Sphinx documentations](https://www.sphinx-doc.org/en/master/index.html)***, we'd better to set a *README.rst* file in a project like:
+
+
+
+
+
+This time I just make a trail docs file. In fact, in a real project, we must write down the descriptions of the project.
+
+In addition, the *[Creating the documentation layout](https://www.sphinx-doc.org/en/master/tutorial/getting-started.html)* is also useful to set up a layout. The specific code is just:
+
+```None
+sphinx-quickstart docs
+```
+
+*In this doc, the consequent screenshots are gained on the Poweshell/Windows platform. The fast layout would be like:*
+
+
+
+As you can see, after you write down the commands, some Chinese reflects are shown in the screen. The root can be set as you wish.
+
+*Then several parameters can be set in the Terminal:*
+
+
+
+*Congratulations！Now you can start write in the index.rst file:*
+
+
+
+------------------------------------------------------------------------------------
+Summary log@2023/09-05@KeranLi: In this cycle, I started to use ***Sphinx*** to manage documentations. I just learned how to install and quick-start. So many details are still waiting for exploring.
diff --git a/docs/source/For Developer/Sphinix Guiding Book.md b/docs/source/For Developer/Sphinix Guiding Book.md
new file mode 100644
index 00000000..32f38406
--- /dev/null
+++ b/docs/source/For Developer/Sphinix Guiding Book.md
@@ -0,0 +1,69 @@
+## Brief Introduction of Sphinx
+
+Sphinx is written in Python and supports Python 3.9+. It builds upon the shoulders of many third-party libraries such as Docutils and Jinja, which are installed when Sphinx is installed.
+
+Sphinx is an amazing tool for writing beautiful documentation. Originally created for the documentation of the Python programming language, it is now popular across numerous developer communities. Most major Python libraries are documented with Sphinx, e.g. NumPy, SciPy, Scikit-Learn, Matplotlib, Django.
+
+## Install by PyPi
+
+For Mac, Window and Linux systems, the most convenient way to install the ***Sphinx*** package is the **Pypi**. The first step is to enter the **geochemistrypi** file and activate the virtual envirnment by:
+
+```None
+cd geochemistry
+conda activate your_env # Conda with Vscode is the most recommended way
+```
+
+*In Windows/CMD, the operation is:*
+
+
+
+*In Windows/Powershell, the operation is:*
+
+
+
+After these preparations, we just need to use ***pip*** to finish the installation via:
+
+```None
+pip install -U sphinx
+```
+
+*In Windows/CMD, the Installation operation is:*
+
+
+
+ *In Windows/Powershell, the Installation operation is:*
+
+
+
+ ## Fast start of the ***Sphinx***
+
+ The ***Sphinx*** ia a convenient tool for documentations in the projects managemnet. From the *[Getting start](https://www.sphinx-doc.org/en/master/tutorial/getting-started.html)* of the official ***[Sphinx documentations](https://www.sphinx-doc.org/en/master/index.html)***, we'd better to set a *README.rst* file in a project like:
+
+
+
+
+
+This time I just make a trail docs file. In fact, in a real project, we must write down the descriptions of the project.
+
+In addition, the *[Creating the documentation layout](https://www.sphinx-doc.org/en/master/tutorial/getting-started.html)* is also useful to set up a layout. The specific code is just:
+
+```None
+sphinx-quickstart docs
+```
+
+*In this doc, the consequent screenshots are gained on the Poweshell/Windows platform. The fast layout would be like:*
+
+
+
+As you can see, after you write down the commands, some Chinese reflects are shown in the screen. The root can be set as you wish.
+
+*Then several parameters can be set in the Terminal:*
+
+
+
+*Congratulations！Now you can start write in the index.rst file:*
+
+
+
+------------------------------------------------------------------------------------
+Summary log@2023/09-05@KeranLi: In this cycle, I started to use ***Sphinx*** to manage documentations. I just learned how to install and quick-start. So many details are still waiting for exploring.
From edde2c615eeef9ec0bd9a893df9fa97e55ac7b41 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=98KeranLi=E2=80=99?= <‘keranli98@outlook.com’>
Date: Wed, 18 Oct 2023 22:20:38 +0800
Subject: [PATCH 4/5] docs: modified the index.rst
---
docs/source/index.rst | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/source/index.rst b/docs/source/index.rst
index b62f4afd..39b7e28f 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -35,6 +35,7 @@ Welcome to Geochemistry π
Docker Deployment
Algorithm Functionality Addition
Complete Pull Request
+ Quick Start of Sphinx
Docs Link
Indices and tables
From 76787fddac1137257b49c613c291ba59a564ee88 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E2=80=98KeranLi=E2=80=99?= <‘keranli98@outlook.com’>
Date: Sun, 22 Oct 2023 15:53:06 +0800
Subject: [PATCH 5/5] docs: Modified a doc about Sphinx.
---
.../Common Operations in Sphinx.md | 54 +++++++++++++++++++
1 file changed, 54 insertions(+)
create mode 100644 docs/source/For Developer/Common Operations in Sphinx.md
diff --git a/docs/source/For Developer/Common Operations in Sphinx.md b/docs/source/For Developer/Common Operations in Sphinx.md
new file mode 100644
index 00000000..d9916cc8
--- /dev/null
+++ b/docs/source/For Developer/Common Operations in Sphinx.md
@@ -0,0 +1,54 @@
+# Common Operations in Sphinx
+
+Takeaway
++ Installation - PyPi(windpows, CMD)
++ Installation - PyPi(windpows, Powershell)
++ Installation - Conda(windpows, waiting for update)
++ Installation - PyPi(MacOS/Linux, waiting for update)
++ Installation - Conda(MacOS/Linux, waiting for update)
++ Fast Build Sphinx
+
+1. Open the **CMD** terminal in the **Windows** and install the **Sphinx** package by the **Pypi**. The first step is to enter the **geochemistrypi** file and activate the virtual envirnment. Then use the **pip** command to install the **Sphinx** package.
+
+```None
+cd geochemistry
+conda activate your_env # Conda with Vscode is the most recommended way
+pip install -U sphinx
+```
+
+
+
+
+2. Open the **Powershell** terminal in the **Windows** and install the **Sphinx** package by the **Pypi**. The steps are close to the CMD way.
+
+
+
+
+
+3. The ***Sphinx*** ia a convenient tool for documentations in the projects managemnet. From the *[Getting start](https://www.sphinx-doc.org/en/master/tutorial/getting-started.html)* of the official ***[Sphinx documentations](https://www.sphinx-doc.org/en/master/index.html)***, we'd better to set a *README.rst* file in a project like:
+
+
+
+
+
+This time I just make a trail docs file. In fact, in a real project, we must write down the descriptions of the project.
+
+In addition, the *[Creating the documentation layout](https://www.sphinx-doc.org/en/master/tutorial/getting-started.html)* is also useful to set up a layout. The specific code is just:
+
+```None
+sphinx-quickstart docs
+```
+
+*In this doc, the consequent screenshots are gained on the Powershell/Windows platform. The fast layout would be like:*
+
+
+
+As you can see, after you write down the commands, some Chinese reflects are shown in the screen. The root can be set as you wish.
+
+*Then several parameters can be set in the Terminal:*
+
+
+
+*Congratulations！Now you can start write in the index.rst file:*
+
+