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.1.tar.gz
(6.9 kB
view details)
Built Distribution
File details
Details for the file documenteer-0.1.1.tar.gz.
File metadata
- Download URL: documenteer-0.1.1.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 59c633178c6ae70516b1ce8c411724e9b41e6f7239cc8fbe11260376924e8d18 |
|
| MD5 | c7fd577bc55d64a5709cc492c2ff2a17 |
|
| BLAKE2b-256 | ad8c3aa3a4134a80a6eab065bb4b2da0eb155d49ec1061da6350719171458179 |
File details
Details for the file documenteer-0.1.1-py3-none-any.whl.
File metadata
- Download URL: documenteer-0.1.1-py3-none-any.whl
- Upload date:
- Size: 9.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 14defba090881b0a2dcfd01096051daa9c3bc17fc61c40d2649a1dc067532be2 |
|
| MD5 | 2da4f58eaa7ce0569811ac031e8cb042 |
|
| BLAKE2b-256 | 16ab01adfda96a02af6762e5b96cd9619f4f0b07ab7e2d178466f710b48eafe6 |
