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.7.tar.gz
(8.9 kB
view details)
Built Distribution
File details
Details for the file documenteer-0.1.7.tar.gz.
File metadata
- Download URL: documenteer-0.1.7.tar.gz
- Upload date:
- Size: 8.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 42bb6a9075e600b48cec67bf6157a77d5600e51fb54475a730d45bfe2c6ecbb9 |
|
| MD5 | 004fe52749f52e2d4098cb4f2014477f |
|
| BLAKE2b-256 | addba6a567838dfd71c785506aa8c76ce5caf5b4947e669c842a90a03f2ea119 |
File details
Details for the file documenteer-0.1.7-py3-none-any.whl.
File metadata
- Download URL: documenteer-0.1.7-py3-none-any.whl
- Upload date:
- Size: 12.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c2b6b24d5c227ca4eee817979d77882a8e9730478b660a2c0f8ace99816083d2 |
|
| MD5 | 915c40caf4e6d0cb8319bd028fe091f1 |
|
| BLAKE2b-256 | 4f5ab01e7ef7b88b1ad85c8d1e0a41dab5da2e621d7931602a52c34ea0507559 |
