ContextLab / ContextLab/CDL-tutorials

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

Open
#27 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
17
Forks
4
PR merge metrics
No merged PRs in 30d

Description

- 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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.