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.2.tar.gz
(6.9 kB
view details)
Built Distribution
File details
Details for the file documenteer-0.1.2.tar.gz.
File metadata
- Download URL: documenteer-0.1.2.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5d905e828af74796f42b02de7addfa468f4e458e88d3329aa5bf3d5897c5b271 |
|
| MD5 | 867237ca3fe1b4356a13732b6e3d49a1 |
|
| BLAKE2b-256 | 55c70aebd9d083ea99e7c35065148fa57cbd3f5763bcd6e49a0a2c55731eba1e |
File details
Details for the file documenteer-0.1.2-py3-none-any.whl.
File metadata
- Download URL: documenteer-0.1.2-py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ab646863831c583aa2f59f214f00ae1b99330d7ce38a151417136fe2213d62f9 |
|
| MD5 | 008e158a1102f9a56cd008d372866bdd |
|
| BLAKE2b-256 | 226da10e6489c6bb77acc2f5804c3db6606e627f2f73a5c6529611a971905ef4 |
