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.5.tar.gz
(8.9 kB
view details)
Built Distribution
File details
Details for the file documenteer-0.1.5.tar.gz.
File metadata
- Download URL: documenteer-0.1.5.tar.gz
- Upload date:
- Size: 8.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 26a6176db5985d8137035e61b421f8e42332b3fb772ab7979d067c02b99a532d |
|
| MD5 | 8d2369f8b1fb349f8fdcf2ca6ffc7fee |
|
| BLAKE2b-256 | c8dc3a9aa35d2d442149509abdf9f5a76fd7855d9f93569ce02100dcacbb8569 |
File details
Details for the file documenteer-0.1.5-py2-none-any.whl.
File metadata
- Download URL: documenteer-0.1.5-py2-none-any.whl
- Upload date:
- Size: 12.8 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 19f9b88db3f6d81898d541a9c1340793071e7bae0b0f0d88f3de01ceaff215bc |
|
| MD5 | f509e3590b047df2a4b0b6bd0ee1f91d |
|
| BLAKE2b-256 | 86f1d00b49584f444861fc07746d3e7d2d39a091fdfc7bb03f894d1878e250ef |
