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 +``` + image + + image + +2. Open the **Powershell** terminal in the **Windows** and install the **Sphinx** package by the **Pypi**. The steps are close to the CMD way. + +image + + image + +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: + +
+ imageimage +
+ +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:* + +image + +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:* + +image + +*Congratulations!Now you can start write in the index.rst file:* + +image