未知
newslynx-sc-homepage的Python项目详细描述
Newslynx SC主页
安装
生产
安装newslynx-sc-homepage以进行活动安装 newslynx-core,运行以下命令:
$ newslynx sc-install https://github.com/newslynx/newslynx-sc-homepage.git
要添加newslynx-sc-homepage所有组织,请运行:
$ newslynx sc-sync
开发
如果要修改/添加sous chefs到newslynx-sc-homepage,请执行 以下内容:
note将通过pip安装newslynx的新版本。
$ git clone https://github.com/newslynx/newslynx-sc-homepage.git
$ cd newslynx-sc-homepage
$ pip install --editable .
您现在应该可以在 开发模式
% newslynx sc-run newslynx_sc_homepage/say_my_name.yaml --myname='Brian Abelson'
测试
需要nose
$ make all_tests
文件
newslynx-sc-homepage的文档位于Read The Docs上。
它是通过以下步骤生成的
- 将此文件(README.md)转换为重新构造的文本文件, 保存到 docs/index.rst
- 运行newslynx sc-docs newslynx_sc_homepage -f rst以生成 newslynx-sc-homepage和 将输出保存到 docs/sous-chefs.rst
- 从这些文件生成sphinx文档。
连续积分
newslynx-sc-homepage的生成可以在上找到 Travis
这个模块是什么?
- README.md
- 此文件
- VERSION
- newslynx-sc-homepage的真相来源版本。
- requirements.txt
- newslynx-sc-homepage的python依赖项。
- MANIFEST.in
- pypi中包含哪些文件的规范 分配。
- 查看此文档 here。
- setup.py
- 构建newslynx-sc-homepage's pypi的规范 分配。
- .travis.yml
- Travis连续集成配置
- 必须在上激活此项目 travis-ci.org 以便在后续更新时运行此操作。
- Makefile
- 管理newslynx-sc-homepage的帮助程序。
- 包括:
- make clean:
- 从这个目录中清除cruft。
- make install:
- 安装newslynx-sc-homepage。假设你在 虚拟环境。
- make all_tests:
- 运行测试。
- make readme
- 将此文件转换为.rst,包括 内容,并将其保存到 docs/index.rst
- make sous_chef_docs
- 以编程方式生成Sous Chef documentation 通过运行 newslynx sc-docs newslynx_sc_homepage/ --format=rst > docs/sous-chefs.rst。
- make all_docs:
- 为newslynx-sc-homepage生成sphinx文档 运行以上两个命令。
- make view_docs
- 在以下位置提供文档 localhost:8000
- make register:
- 上的寄存器newslynx-sc-homepagePyPI。
- make distribute:
- 将newslynx-sc-homepage的新版本发布到pypi。
- make clean:
- CONTRIBUTING.md
- newslynx_sc_homepage
- newslynx-sc-homepage的源代码和sous chef配置 文件夹。
- docs
- newslynx-sc-homepage 的sphnix文档
- tests
- nose测试newslynx-sc-homepage