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`.
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.10.tar.gz
(11.3 kB
view details)
Built Distribution
File details
Details for the file documenteer-0.1.10.tar.gz.
File metadata
- Download URL: documenteer-0.1.10.tar.gz
- Upload date:
- Size: 11.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 89c554072dcffedbcfd7218f1e2d7abbc41921c6a86a587a3504e978925f46f0 |
|
| MD5 | 996dfcacf3e9a85b944bee2fb9c5d566 |
|
| BLAKE2b-256 | f981b32f3ef4e977081e3459a0af5628339664009b89d1fc3f61d7a103832df0 |
File details
Details for the file documenteer-0.1.10-py2-none-any.whl.
File metadata
- Download URL: documenteer-0.1.10-py2-none-any.whl
- Upload date:
- Size: 17.9 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ba4b3e516a97084a8b8dd22bf835032853a70b3a9ca22fc33b2b71b498133a50 |
|
| MD5 | 2052ae4d20174523011e42940b282871 |
|
| BLAKE2b-256 | 937cc0f474fff3430679b6f8a5e7d54678cd996f92f6ad11be3c1a566648ed54 |
