lsst dm文档项目的工具
documenteer的Python项目详细描述
文档管理员
用于LSST Data Management项目的sphinx文档工具。
浏览lsst-doc-engineeringgithub主题以获取更多lsst文档工程项目。
安装
如何安装documenteer取决于使用它的项目:
- 对于技术说明项目:pip install documenteer[technote]
- 对于https://pipelines.lsst.io项目:pip install documenteer[pipelines]
发展
使用您选择的方法(virtualenvwrapper或conda)创建虚拟环境,然后克隆或分叉,然后安装:
git clone https://github.com/lsst-sqre/documenteer.git cd documenteer pip install -e ".[dev]"
发布:
- 更新CHANGELOG.rst。
- 标签:git tag -s X.Y.Z -m "X.Y.Z"
- 推:git push --tags
使用PEP 440-compliant版本标识符。
Travis CI处理pypi部署。