newslynx-sc-example 0.0.1

安装

$ pip install newslynx-sc-example

$ mkvirtualenv newslynx-sc-example
$ git clone https://github.com/newslynx/newslynx-sc-example.git
$ cd newslynx-sc-example
$ pip install .

测试

需要nose

$ nosetests

文档化

newslynx-sc-example的文档位于Read The Docs。

它是通过以下步骤生成的

• 将此文件（README.md）转换为重新构造的文本文件， 保存到 docs/index.rst
• 运行newslynx sc-docs newslynx_sc_example -f rst以生成 newslynx-sc-example和 将输出保存到 docs/sous-chefs.rst
• 从这些文件中生成sphinx文档。

连续积分

newslynx-sc-example的生成可以在上找到 Travis

贡献

请参阅contributing guidelines。

这个模块是什么？

• README.md
  • 此文件
• VERSION
  • newslynx-sc-example的真相来源版本。
• requirements.txt
  • newslynx-sc-example的python依赖项。
• MANIFEST.in
  • pypi中包含哪些文件的规范 分配。
  • 查看此文档 here。
• setup.py
  • 构建newslynx-sc-example的pypi的规范 数据分发。
• .travis.yml
  • Travis连续集成配置
  • 必须在上激活此项目 travis-ci.org 以便在后续更新时运行此操作。
• Makefile
  • 管理newslynx-sc-example的帮助程序。
  • 包括：
    • make clean：
      • 从这个目录中清除cruft。
    • make install：
      • 安装newslynx-sc-example。假设你在 虚拟环境。
    • make tests：
      • 运行测试。
    • make readme
      • 将此文件转换为.rst，包括 内容，并将其保存到 docs/index.rst
    • make sous_chef_docs
      • 以编程方式生成Sous Chef documentation 通过运行 newslynx sc-docs newslynx_sc_example/ --format=rst > docs/sous-chefs.rst。
    • make all_docs：
      • 为newslynx-sc-example生成sphinx文档 运行以上两个命令。
    • make view_docs
      • 在以下位置提供文档 localhost:8000
    • make register：
      • 上的寄存器newslynx-sc-examplePyPI。
    • make distribute：
      • 将newslynx-sc-example的新版本发布到pypi。
• CONTRIBUTING.md
• newslynx_sc_example
  • newslynx-sc-example的源代码和sous chef配置 文件夹。
• docs
  • newslynx-sc-example
  的sphnix文档
• tests
  • nose测试newslynx-sc-example