Learning_Python 项目安装与配置指南

1. 项目基础介绍

Learning_Python 是一个开源项目，旨在提供 Python 编程语言的深入学习和实践资源。该项目包含了丰富的学习材料，主要针对希望通过 Jupyter Notebook 和 Markdown 语法来学习和贡献内容的用户。项目内容涵盖 Python 基础知识、数据科学相关主题以及一些高级特性。

主要编程语言：Python

2. 项目使用的关键技术和框架

• Jupyter Notebook：用于创建和共享包含代码、方程、可视化和文本的文档。
• Markdown：轻量级标记语言，用于格式化文本内容。
• Sphinx：一个Python文档生成器，用于从 .rst 或 .md 文件生成 HTML 文档。
• nbsphinx：用于将 Jupyter Notebook 转换为 Sphinx 文档的工具。
• pandoc：一个强大的文档转换工具，支持多种标记格式的相互转换。
• mygrad：一个用于自动微分的 Python 库。

3. 项目安装和配置的准备工作与详细步骤

准备工作

• 安装 Miniconda 或 Anaconda（推荐 Miniconda，因为它是 Anaconda 的轻量级版本）。
• 确保你的系统中已安装 Python 3.8。

安装步骤

1. 创建 Miniconda 环境

   打开命令行，执行以下命令创建名为 plymi 的环境，并指定 Python 版本为 3.8：

   conda create -n plymi python=3.8
   

2. 激活环境

   在命令行中激活创建的环境：

   conda activate plymi
   

3. 安装依赖

   使用 conda-forge 通道安装项目所需的依赖：

   conda install -c conda-forge sphinx==4.4.0 jupytext==1.13.6 nbsphinx==0.8.8 pandoc==2.1.3 sphinx_rtd_theme==1.0.0 ipykernel==6.7.0 numpy matplotlib
   

   接下来，使用 pip 安装 mygrad：

   pip install mygrad
   

4. 克隆仓库

   克隆项目仓库到本地：

   git clone https://github.com/rsokl/Learning_Python.git
   cd Learning_Python
   

5. 安装项目代码库

   在项目目录下，使用 pip 安装本地代码库：

   pip install .
   

6. 构建 HTML 文档

   在项目目录下，执行以下命令构建 HTML 文档：

   import plymi.plymi
   plymi.plymi.convert_src_to_html("./Python")
   

   这将把 .rst 和 .md 文件转换为 HTML 文档。

7. 查看本地站点

   构建完成后，HTML 文件将位于 Python/_build 目录。在浏览器中打开 index.html 文件，查看本地构建的站点。

注意：如果你在项目中引入了新页面或进行了影响导航栏的更改，请在构建 HTML 之前删除 _build 目录，以确保 Sphinx 从头开始生成页面。