ContextLab / ContextLab/CDL-tutorials

add script to generate all non-code files automatically if they don't exist

未关闭
#27 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Jupyter Notebook
星标
17
派生
4
PR 合并指标
30 天内没有已合并 PR

描述

- setup.py (use folder name as name of project, and if any of the below are specified, change the script accordingly to reference them)

other info could be read from setup.py
- conf.py
- MANIFEST.in
- README.md
- requirements.txt
- license.txt
- basic test (so pytest can run)
- basic example (so sphinx compiles)
- api.rst
- index.rst
- tutorials.rst
- sample tutorial notebook

then output a "to do" list of how to:
- set up github web hooks for slack
- get travis configured
- compile sphinx web page
- register on readthedocs and publish readthedocs page
- do a github release
- set up forks on github for development (once package is "live," rather than modifying master branch directly)
- push to pip (after package is ready for release)
- install package from pip

贡献指南

这个仓库没有索引到贡献指南

调研方向

Start by reviewing the requested generated files: setup.py, conf.py, MANIFEST.in, README.md, requirements.txt, license.txt, api.rst, index.rst, tutorials.rst, and the example notebook. Define how the script should detect missing files and how setup.py values affect them. Done means missing package, test, example, and documentation files are generated and the requested GitHub, Travis, Read the Docs, release, fork, and pip steps are output as a to-do list.

由索引模型根据 Issue 内容生成。

评估

技术栈
jupyter-notebook, python
领域
build-system, documentation, testing, tooling
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。