Tools for LSST DM documentation projects

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jonathansick from gravatar.com jonathansick Avatar for sqre-admin from gravatar.com sqre-admin

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

PyPI MIT license Uses wheel For Python 3.5+

Documenteer

Sphinx documentation tools for LSST Data Management projects.

Browse the lsst-doc-engineering GitHub topic for more LSST documentation engineering projects.

Installation

How you install Documenteer depends on the project you’re using it for:

  • For technical note projects: pip install documenteer[technote]

  • For the https://pipelines.lsst.io project: pip install documenteer[pipelines]

Development

Create a virtual environment with your method of choice (virtualenvwrapper or conda) and then clone or fork, and install:

git clone https://github.com/lsst-sqre/documenteer.git
cd documenteer
pip install -e ".[dev]"

To make a release:

  1. Update CHANGELOG.rst.

  2. Tag: git tag -s X.Y.Z -m "X.Y.Z"

  3. Push: git push --tags

Use a PEP 440-compliant version identifiers.

Travis CI handles the PyPI deployment.

License and info

Documenteer is a project by the Large Synoptic Survey Telescope.

MIT licensed. See LICENSE for details.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for jonathansick from gravatar.com jonathansick Avatar for sqre-admin from gravatar.com sqre-admin

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

2.0.0a2 pre-release

1.4.2

1.4.1

1.4.0

1.3.0

1.2.2

1.2.1

1.2.0

1.1.1

1.1.0

1.0.1

1.0.1a1 pre-release

1.0.0

1.0.0a18 pre-release

1.0.0a17 pre-release

1.0.0a16 pre-release

1.0.0a15 pre-release

1.0.0a14 pre-release

1.0.0a13 pre-release

1.0.0a12 pre-release

1.0.0a11 pre-release

1.0.0a10 pre-release

1.0.0a9 pre-release

1.0.0a8 pre-release

1.0.0a7 pre-release

1.0.0a6 pre-release

1.0.0a2 pre-release

1.0.0a1 pre-release

0.8.4

0.8.3

0.8.2

0.8.1

0.8.0

0.8.0b2 pre-release

0.8.0b1 pre-release

0.7.5

0.7.4

0.7.3

0.7.2

0.7.1

0.7.0

0.7.0b4 pre-release

0.7.0b3 pre-release

0.7.0b2 pre-release

0.7.0b1 pre-release

0.6.14

0.6.13

0.6.12

0.6.11

0.6.10

0.6.9

0.6.8

0.6.7

0.6.6

0.6.5

0.6.4

0.6.2

0.6.1

0.6.0

0.6.0rc1 pre-release

0.5.12

0.5.11

0.5.10

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.5.0a3 pre-release

0.5.0a2 pre-release

0.5.0a1 pre-release

0.4.7

0.4.6

0.4.5

0.4.4

0.4.3

0.4.2

0.4.1

0.4.0

0.4.0a1 pre-release

This version

0.3.1

0.3.0

0.3.0a6 pre-release

0.3.0a5 pre-release

0.3.0a4 pre-release

0.3.0a3 pre-release

0.3.0a2 pre-release

0.3.0a1 pre-release

0.2.8

0.2.7

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.11

0.1.10

0.1.9

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.2

0.1.1

0.1.0

0.1.0.dev0 pre-release

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.3.1.tar.gz (49.7 kB view details)

Uploaded Source

Built Distribution

documenteer-0.3.1-py3-none-any.whl (38.3 kB view details)

Uploaded Python 3

File details

Details for the file documenteer-0.3.1.tar.gz.

File metadata

  • Download URL: documenteer-0.3.1.tar.gz
  • Upload date:
  • Size: 49.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3

File hashes

Hashes for documenteer-0.3.1.tar.gz
Algorithm Hash digest
SHA256 873fcb7ca7ec324ffc56a1e9e75acf45ed49679268d8d032afca5ca87783fa18
MD5 bc5d9148e023e1ef63bd676ecc6490b4
BLAKE2b-256 43a3a9eb754d57d162af41376620e36a952e77e6220250cef669c9f3e56e9e33

See more details on using hashes here.

File details

Details for the file documenteer-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: documenteer-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 38.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.3

File hashes

Hashes for documenteer-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f05c7c986375ce1ad9ff148aba37104136cb7fba9c972abd03017f55a1e868e4
MD5 1b721f247083afdacce0e0e8cb3f60b0
BLAKE2b-256 5ac88141ed7f5b7a13539a83fff3152e3f38a2a6e260dbaa81eeb076116fa13d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page