python 创建工具包_使用Python工具建立网站-白红宇

python 创建工具包_使用Python工具建立网站

阅读量：2521 次

发布时间：2019-05-11

本文共 3038 字，大约阅读时间需要 10 分钟。

python 创建工具包

并非每个网站都是博客，博客的主要功能是帖子列表，每个帖子都有特定的时间戳，以指示其“新鲜度”。有时，您只想要一个网站。

也许您是一名业余（或专业！）厨师，并且想炫耀自己的食谱。也许您是一位诗人，并且想要一个网站发布您所有的诗。也许您有很强的见解，并希望有一个地方来存储您的蚂蚁，每个蚂蚁都是永恒的完美。这是进来的地方。

建立一个Sphinx网站

工程师们正在努力构建最低限度的可行产品，并且营销需要建立一个有吸引力的网站来展示该解决方案。没有可用的工程资源，因为所有人都致力于解决乘法和求反问题，并且预算很少，您该怎么办？

故事从本地Git存储库开始，以便对网站进行。

像所有好的Git存储库一样，该库以.gitignore开头，它告诉Git忽略其中列出的文件或目录。这是一个简单，不起眼的.gitignore ：

/build

我将解释为什么要将这个目录添加到下面的.gitignore文件中。

接下来，是时候让广告撰写人开始撰写市场营销副本了。在doc / index.rst中 ，他们编写格式正确的：

Calculate Solutions     
     -------------------     
          
     Learn how to add, subtract, multiply, and divide!     
          
     .. toctree::     
          
         multiplication     
         negation

标点符号的使用和toctree的使用使我们可以创建要构建的子页面的目录。接下来，我们可以在doc / multiplication.rst和doc / negation.rst中放置有关Calculate Solutions特定产品的更多详细信息。

然后添加一个简短的文件doc / conf.py ，其中包含重要的元数据：

master_doc      
     =      
     'index'      
     project      
     =      
     "Calculate.Solutions"      
     copyright      
     =      
     '2020, Calculate Solutions, Inc.'      
     author      
     =      
     'Calculate Solutions, Inc.'      
     version      
     = release      
     =      
     ''

并设置版本并将其发布为空字符串。 Sphinx的最初目的是记录软件，这是一个用例，其中版本和发行标签很重要，但对Calculate Solutions的网站没有用。

最后，请确保您可以在本地生成文档，并确定它看起来不错。为此，请使用方便的自动化和测试库。

将以下tox配置文件保存到tox.ini中 ：

[ tox ]      
          
     envlist      
     =      
      website      
          
     toxworkdir      
     =      
      {
        toxinidir } /build/tox      
          
     skipsdist      
     =      
      True      
          
          
     [ testenv:website ]      
          
     basepython      
     =      
      python3.7      
          
     deps      
     =      
         sphinx     
          
     changedir      
     =      
      doc      
          
     commands      
     =      
         sphinx-build -W -b html -d      
     {
       envtmpdir      
     } /doctrees .      
     {
       envtmpdir      
     } /html

Tox配置分为两部分：一是常规配置，一是设置特定的“测试环境”。常规配置设置测试环境列表；在这里，您只有一个，一个在本地构建您的网站。您还必须配置工作目录。这很有用，因为默认情况下，tox会将其输出放入.tox目录中。有时很难从Web浏览器之类的GUI程序中打开这样的“隐藏”目录。因此，将其放在build下，即您在.gitignore中要忽略的目录。

默认情况下，tox假定您正在测试Python软件包。由于您不是，所以将其告知skipsdist 。

在环境配置中，明确说明要使用哪个Python解释器。 Tox有时会尝试从环境名称中推断出这一点，但是在这种情况下，检测无法正常工作。确保您在此处设置的版本在您的路径中可用。

从那里，告诉tox 在它为此运行创建的虚拟环境中，然后转到您的doc目录，在其中放置您的配置和市场营销副本，并运行用于构建网站的sphinx命令。

现在您可以简单地运行：