Tools for LSST DM documentation projects
Project description
###########
documenteer
###########
.. image:: https://img.shields.io/pypi/v/documenteer.svg?style=flat-square
.. image:: https://img.shields.io/pypi/l/documenteer.svg?style=flat-square
.. image:: https://img.shields.io/pypi/wheel/documenteer.svg?style=flat-square
.. image:: https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square
Documentation tools for `LSST Data Management <http://dm.lsst.org>`_ projects, including Sphinx extensions.
Installation
============
.. code-block:: bash
pip install documenteer
Development
===========
Create a virtual environment with your method of choice (virtualenvwrapper or conda) and then clone or fork, and install::
.. code-block:: bash
git clone https://github.com/lsst-sqre/documenteer.git
pip install -r requirements.txt
python setup.py develop
We use `zest.releaser <http://zestreleaser.readthedocs.org>`_ to manage releases.
To make a release
1. Update the :file:`CHANGELOG.rst`
2. Run ``fullrelease``
3. ``git push --tags``
License
=======
MIT Licensed. See :file:`LICENSE` and :file:`COPYRIGHT`.
documenteer
###########
.. image:: https://img.shields.io/pypi/v/documenteer.svg?style=flat-square
.. image:: https://img.shields.io/pypi/l/documenteer.svg?style=flat-square
.. image:: https://img.shields.io/pypi/wheel/documenteer.svg?style=flat-square
.. image:: https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square
Documentation tools for `LSST Data Management <http://dm.lsst.org>`_ projects, including Sphinx extensions.
Installation
============
.. code-block:: bash
pip install documenteer
Development
===========
Create a virtual environment with your method of choice (virtualenvwrapper or conda) and then clone or fork, and install::
.. code-block:: bash
git clone https://github.com/lsst-sqre/documenteer.git
pip install -r requirements.txt
python setup.py develop
We use `zest.releaser <http://zestreleaser.readthedocs.org>`_ to manage releases.
To make a release
1. Update the :file:`CHANGELOG.rst`
2. Run ``fullrelease``
3. ``git push --tags``
License
=======
MIT Licensed. See :file:`LICENSE` and :file:`COPYRIGHT`.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
documenteer-0.1.4.tar.gz
(8.9 kB
view details)
Built Distribution
File details
Details for the file documenteer-0.1.4.tar.gz.
File metadata
- Download URL: documenteer-0.1.4.tar.gz
- Upload date:
- Size: 8.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4e1e1ac2d5f59028ac7d6023361e1f7113b632839cdfdf008ea8a70b4e1a698b |
|
| MD5 | e3e72682486fbb5a482bf0b96fe59c55 |
|
| BLAKE2b-256 | ae16f56d198f906db370fb5c643285476ec78b14e2c22f895c984fd9f5c54a57 |
File details
Details for the file documenteer-0.1.4-py2-none-any.whl.
File metadata
- Download URL: documenteer-0.1.4-py2-none-any.whl
- Upload date:
- Size: 12.8 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 782e35834da61beab17b767867c547af301b8a97064a78de232d7c15945cad74 |
|
| MD5 | d96271163c96f4f5c51ad47419433921 |
|
| BLAKE2b-256 | 2eb6a4f0feb68de8659c24059e5d8e95bd3478edfe91205adc87a38de75de598 |
