Create Docs

sunfounder · Nov 17, 2021 · 45827dd · 45827dd
1 parent 45a11fa
commit 45827dd
Show file tree

Hide file tree

Showing 207 changed files with 3,560 additions and 1,196 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "restructuredtext.confPath": "${workspaceFolder}\\docs\\source"
+}
diff --git a/.vscode/sftp.json b/.vscode/sftp.json
@@ -0,0 +1,26 @@
+{
+    "host": "192.168.6.199",
+    "port": 22,
+    "username": "pi",
+    "password": "raspberry",
+    "protocol": "sftp",
+    "agent": null,
+    "privateKeyPath": null,
+    "passphrase": null,
+    "passive": false,
+    "interactiveAuth": true,
+    "remotePath": "/home/pi/pan-tilt-hat",
+    "uploadOnSave": true,
+    "syncMode": "update",
+    "ignore": [
+        "**/.vscode/**",
+        "**/.git/**",
+        "**/.DS_Store"
+    ],
+    "watcher": {
+        "files": "glob",
+        "autoUpload": true,
+        "autoDelete": true
+    }
+
+}
diff --git a/docs/source/appendix/appendix.rst b/docs/source/appendix/appendix.rst
@@ -0,0 +1,11 @@
+Appendix
+=================
+
+
+.. toctree::
+
+    filezilla
+    i2c_configuration
+    remote_desktop
+
+
diff --git a/docs/source/appendix/filezilla.rst b/docs/source/appendix/filezilla.rst
@@ -0,0 +1,31 @@
+Filezilla Software
+==========================
+
+.. image:: image/filezilla_icon.png
+
+The File Transfer Protocol (FTP) is a standard communication protocol used for the transfer of computer files from a server to a client on a computer network.
+
+Filezilla is an open source software that not only supports FTP, but also FTP over TLS (FTPS) and SFTP. We can use Filezilla to upload local files (such as pictures and audio, etc.) to the Raspberry Pi, or download files from the Raspberry Pi to the local.
+
+**Step 1**: Download Filezilla.
+
+Download the client from `Filezilla’s official website <https://filezilla-project.org/>`_, Filezilla has a very good tutorial, please refer to: `Documentation - Filezilla <https://wiki.filezilla-project.org/Documentation>`_.
+
+**Step 2**: Connect to Raspberry Pi
+
+After a quick install open it up and now `connect it to an FTP server <https://wiki.filezilla-project.org/Using#Connecting_to_an_FTP_server>`_. It has 3 ways to connect, here we use the **Quick Connect** bar. Enter the **hostname/IP**, **username**, **password** and **port (22)**, then click **Quick Connect** or press **Enter** to connect to the server.
+
+.. image:: image/filezilla_connect.png
+
+.. note::
+
+    Quick Connect is a good way to test your login information. If you want to create a permanent entry, you can select **File**-> **Copy Current Connection to Site Manager** after a successful Quick Connect, enter the name and click **OK**. Next time you will be able to connect by selecting the previously saved site inside **File** -> **Site Manager**.
+
+    .. image:: image/ftp_site.png
+
+**Step 3**: Upload/download files.
+
+You can upload local files to Raspberry Pi by dragging and dropping them, or download the files inside Raspberry Pi
+files locally.
+
+.. image:: image/upload_ftp.png
diff --git a/docs/source/appendix/i2c_configuration.rst b/docs/source/appendix/i2c_configuration.rst
@@ -0,0 +1,30 @@
+I2C Configuration
+-----------------------
+
+Enable the I2C port of your Raspberry Pi (If you have
+enabled it, skip this; if you do not know whether you have done that or
+not, please continue).
+
+.. raw:: html
+
+    <run></run>
+
+.. code-block:: 
+
+    sudo raspi-config
+
+**3 Interfacing options**
+
+.. image:: image/image282.png
+    :align: center
+
+**P5 I2C**
+
+.. image:: image/image283.png
+    :align: center
+
+**<Yes>, then <Ok> -> <Finish>**.
+
+.. image:: image/image284.png
+    :align: center
+
diff --git a/docs/source/appendix/image/filezilla_connect.png b/docs/source/appendix/image/filezilla_connect.png
diff --git a/docs/source/appendix/image/filezilla_icon.png b/docs/source/appendix/image/filezilla_icon.png
diff --git a/docs/source/appendix/image/ftp_site.png b/docs/source/appendix/image/ftp_site.png
diff --git a/docs/source/appendix/image/image20.png b/docs/source/appendix/image/image20.png
diff --git a/docs/source/appendix/image/image282.png b/docs/source/appendix/image/image282.png
diff --git a/docs/source/appendix/image/image283.png b/docs/source/appendix/image/image283.png
diff --git a/docs/source/appendix/image/image284.png b/docs/source/appendix/image/image284.png
diff --git a/docs/source/appendix/image/image285.png b/docs/source/appendix/image/image285.png
diff --git a/docs/source/appendix/image/image286.png b/docs/source/appendix/image/image286.png
diff --git a/docs/source/appendix/image/image287.png b/docs/source/appendix/image/image287.png
diff --git a/docs/source/appendix/image/image288.png b/docs/source/appendix/image/image288.png
diff --git a/docs/source/appendix/image/image289.png b/docs/source/appendix/image/image289.png
diff --git a/docs/source/appendix/image/image290.png b/docs/source/appendix/image/image290.png
diff --git a/docs/source/appendix/image/image291.png b/docs/source/appendix/image/image291.png
diff --git a/docs/source/appendix/image/image292.png b/docs/source/appendix/image/image292.png
diff --git a/docs/source/appendix/image/image293.png b/docs/source/appendix/image/image293.png
diff --git a/docs/source/appendix/image/image294.png b/docs/source/appendix/image/image294.png
diff --git a/docs/source/appendix/image/image295.png b/docs/source/appendix/image/image295.png
diff --git a/docs/source/appendix/image/image296.png b/docs/source/appendix/image/image296.png
diff --git a/docs/source/appendix/image/image297.png b/docs/source/appendix/image/image297.png
diff --git a/docs/source/appendix/image/upload_ftp.png b/docs/source/appendix/image/upload_ftp.png
diff --git a/docs/source/appendix/remote_desktop.rst b/docs/source/appendix/remote_desktop.rst
@@ -0,0 +1,172 @@
+Remote Desktop
+=====================
+
+There are two ways to control the desktop of the Raspberry Pi remotely:
+
+**VNC** and **XRDP**, you can use any of them.
+
+VNC 
+--------------
+
+You can use the function of remote desktop through VNC.
+
+**Enable VNC service**
+
+The VNC service has been installed in the system. By default, VNC is
+disabled. You need to enable it in config.
+
+**Step 1**
+
+Input the following command:
+
+.. raw:: html
+
+    <run></run>
+
+.. code-block:: 
+
+    sudo raspi-config
+
+.. image:: image/image287.png
+   :align: center
+
+**Step 2**
+
+Choose **3** **Interfacing Options** by press the down arrow key on your
+keyboard, then press the **Enter** key.
+
+.. image:: image/image282.png
+   :align: center
+
+**Step 3**
+
+**P3 VNC**
+
+.. image:: image/image288.png
+   :align: center
+
+**Step 4**
+
+Select **Yes -> OK -> Finish** to exit the configuration.
+
+.. image:: image/image289.png
+   :align: center
+
+**Login to VNC**
+
+**Step 1**
+
+You need to download and install the `VNC Viewer <https://www.realvnc.com/en/connect/download/viewer/>`_ on personal computer. After the installation is done, open it.
+
+**Step 2**
+
+Then select \"**New connection**\".
+
+.. image:: image/image290.png
+   :align: center
+
+**Step 3**
+
+Input IP address of Raspberry Pi and any **Name**.
+
+.. image:: image/image291.png
+   :align: center
+
+**Step 4**
+
+Double click the **connection** just created:
+
+.. image:: image/image292.png
+   :align: center
+
+**Step 5**
+
+Enter Username (**pi**) and Password (**raspberry** by default).
+
+.. image:: image/image293.png
+   :align: center
+
+**Step 6**
+
+Now you can see the desktop of the Raspberry Pi:
+
+.. image:: image/image294.png
+   :align: center
+
+That's the end of the VNC part.
+
+
+XRDP
+-----------------------
+
+Another method of remote desktop is XRDP, it provides a graphical login to remote machines using RDP (Microsoft
+Remote Desktop Protocol).
+
+**Install XRDP**
+
+**Step 1**
+
+Login to Raspberry Pi by using SSH.
+
+**Step 2**
+
+Input the following instructions to install XRDP.
+
+.. raw:: html
+
+    <run></run>
+
+.. code-block:: 
+
+   sudo apt-get update
+   sudo apt-get install xrdp
+
+**Step 3**
+
+Later, the installation starts.
+
+Enter \"Y\", press key \"Enter\" to confirm.
+
+.. image:: image/image295.png
+   :align: center
+
+**Step 4**
+
+Finished the installation, you should login to your Raspberry Pi by
+using Windows remote desktop applications.
+
+**Login to XRDP**
+
+**Step 1**
+
+If you are a Windows user, you can use the Remote Desktop feature that
+comes with Windows. If you are a Mac user, you can download and use
+Microsoft Remote Desktop from the APP Store, and there is not much
+difference between the two. The next example is Windows remote desktop.
+
+**Step 2**
+
+Type in \"**mstsc**\" in Run (WIN+R) to open the Remote Desktop
+Connection, and input the IP address of Raspberry Pi, then click on
+\"Connect\".
+
+.. image:: image/image296.png
+   :align: center
+
+**Step 3**
+
+Then the xrdp login page pops out. Please type in your username and
+password. After that, please click \"OK\". At the first time you log in,
+your username is \"pi\" and the password is \"raspberry\".
+
+.. image:: image/image297.png
+   :align: center
+
+**Step 4**
+
+Here, you successfully login to RPi by using the remote desktop.
+
+.. image:: image/image20.png
+   :align: center
+
+
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -16,33 +16,24 @@
 
 
 # -- Project information -----------------------------------------------------
+import sphinx_rtd_theme
 
-project = 'pan-tilt-hat'
+project = 'SunFounder PiCrawler Kit'
 copyright = '2021, sunfounder'
-author = 'sunfounder'
-
-# The full version, including alpha/beta/rc tags
-release = '1.0'
+author = 'www.sunfounder.com'
 
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
+extensions = ['sphinx.ext.autosectionlabel'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = 'en'
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
@@ -54,18 +45,31 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-import sphinx_rtd_theme
 html_theme = 'sphinx_rtd_theme'
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+
 html_js_files = [
     'https://ezblock.cc/readDocFile/topHead.js',
+    'https://ezblock.cc/readDocFile/readTheDoc/src/js/ace.js',
+    'https://ezblock.cc/readDocFile/readTheDoc/src/js/mode-python.js',
+    'https://ezblock.cc/readDocFile/readTheDoc/src/js/mode-sh.js',
+    'https://ezblock.cc/readDocFile/readTheDoc/src/js/monokai.js',
+    'https://ezblock.cc/readDocFile/readTheDoc/src/js/xterm.js',
+    'https://ezblock.cc/readDocFile/readTheDoc/src/js/FitAddon.js',
+    'https://ezblock.cc/readDocFile/readTheDoc/src/js/readTheDocIndex.js',
 ]
 html_css_files = [
     'https://ezblock.cc/readDocFile/topHead.css',
+    'https://ezblock.cc/readDocFile/readTheDoc/src/css/index.css',
+    'https://ezblock.cc/readDocFile/readTheDoc/src/css/xterm.css',
 ]
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+language = 'en'
+locale_dirs = ['locale/'] 
+
+gettext_compact = False