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
To make a release:
1. Update the :file:`CHANGELOG.rst`.
2. Increment version in :file:`setup.py`.
3. Tag: ``git tag -s -m "Version X.Y.Z" vX.Y.Z``
4. Build:
.. code-block:: bash
rm -R dist
python setup.py sdist bdist_wheel
5. Upload:
.. code-block:: bash
twine upload dist/*
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
To make a release:
1. Update the :file:`CHANGELOG.rst`.
2. Increment version in :file:`setup.py`.
3. Tag: ``git tag -s -m "Version X.Y.Z" vX.Y.Z``
4. Build:
.. code-block:: bash
rm -R dist
python setup.py sdist bdist_wheel
5. Upload:
.. code-block:: bash
twine upload dist/*
git push --tags
License
=======
MIT Licensed. See :file:`LICENSE` and :file:`COPYRIGHT`.
Project details
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.9.tar.gz
(9.2 kB
view hashes)
Built Distribution
Close
Hashes for documenteer-0.1.9-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6f82b68ea6b9b5fe9d12157f8f53482dfa8eae9f069a915bf213a9de4a18686c |
|
MD5 | 346820119addd16b4187aa0cd77ee06b |
|
BLAKE2b-256 | 0e763fafc260b781f6936e3298871b0049514c705dcdaea7bac3441e838bbf5e |