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

This version

0.4.5

0.4.4

0.4.3

0.4.2

0.4.1

0.4.0

0.4.0a1 pre-release

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

Uploaded Source

Built Distribution

documenteer-0.4.5-py3-none-any.whl (58.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: documenteer-0.4.5.tar.gz
  • Upload date:
  • Size: 72.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.3

File hashes

Hashes for documenteer-0.4.5.tar.gz
Algorithm Hash digest
SHA256 51c669323bb4f92a158fcb064296cbd40eae05d1f535458acd447284b5fc59e1
MD5 702c26db5d731096c61b56e2c40d4ded
BLAKE2b-256 1fa04fd6220d01fcca4862be9abf4b011b6eecc801a9925544dd2761879f2712

See more details on using hashes here.

File details

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

File metadata

  • Download URL: documenteer-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 58.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.3

File hashes

Hashes for documenteer-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a452360f4ba2f6cd2ac9d7293fa0e30058073afbfe51947a76f975657a3f01f7
MD5 9b18071e48ee71e14d7fdb33ba4b3399
BLAKE2b-256 f6b339b80f37b992499369c6698e2e940aa6e1acb055b137add1c8d410ef0bbc

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