Skip to main content

Tools for building the Ansible Distribution

Project description

antsibull -- Ansible Build Scripts

Python linting badge Python testing badge Build CSS testing badge dumb PyPI on GH pages badge Codecov badge

Tooling for building various things related to Ansible

Scripts that are here:

  • antsibull-build - Builds Ansible-2.10+ from component collections (docs)
  • antsibull-docs - Extracts documentation from ansible plugins
  • antsibull-lint - Right now only validates changelogs/changelog.yaml files (docs)

This also includes a Sphinx extension sphinx_antsibull_ext which provides a lexer for Ansible output and a minimal CSS file to render the output of antsibull-docs correctly.

A related project is antsibull-changelog, which is in its own repository.

Scripts are created by poetry at build time. So if you want to run from a checkout, you'll have to run them under poetry::

python3 -m pip install poetry
poetry install  # Installs dependencies into a virtualenv
poetry run antsibull-build --help

.. note:: When installing a package published by poetry, it is best to use pip >= 19.0. Installing with pip-18.1 and below could create scripts which use pkg_resources which can slow down startup time (in some environments by quite a large amount).

Unless otherwise noted in the code, it is licensed under the terms of the GNU General Public License v3 or, at your option, later.

Using the Sphinx extension

Include it in your Sphinx configuration conf.py::

# Add it to 'extensions':
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'notfound.extension', 'sphinx_antsibull_ext']

Updating the CSS file for the Sphinx extension

The CSS file sphinx_antsibull_ext/antsibull-minimal.css is built from sphinx_antsibull_ext/css/antsibull-minimal.scss using SASS and postcss using autoprefixer and cssnano.

Use the script build.sh in sphinx_antsibull_ext/css/ to build the .css file from the .scss file:

cd sphinx_antsibull_ext/css/
./build-css.sh

For this to work, you need to make sure that sassc and postcss are on your path and that the autoprefixer and nanocss modules are installed:

# Debian:
apt-get install sassc

# PostCSS, autoprefixer and cssnano require nodejs/npm:
npm install -g autoprefixer cssnano postcss postcss-cli

Creating a new release:

If you want to create a new release::

poetry build
poetry publish  # Uploads to pypi.  Be sure you really want to do this

git tag $VERSION_NUMBER
git push --tags
vim pyproject.toml    # Bump the version number
git commit -m 'Update the version number for the next release' pyproject.toml
git push

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

antsibull-0.32.0.tar.gz (183.1 kB view details)

Uploaded Source

Built Distribution

antsibull-0.32.0-py3-none-any.whl (193.3 kB view details)

Uploaded Python 3

File details

Details for the file antsibull-0.32.0.tar.gz.

File metadata

  • Download URL: antsibull-0.32.0.tar.gz
  • Upload date:
  • Size: 183.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.46.0 CPython/3.8.10

File hashes

Hashes for antsibull-0.32.0.tar.gz
Algorithm Hash digest
SHA256 652e5492931edb585a0c90c9e59fbc8af9c67a1601689ea4b2138de30df17bea
MD5 99fc5175b568f288225bcdbec6d022d5
BLAKE2b-256 f31adc022afac96785d4bc8887203fa0b4deb804472456d81652ed0a33a6c4b7

See more details on using hashes here.

Provenance

File details

Details for the file antsibull-0.32.0-py3-none-any.whl.

File metadata

  • Download URL: antsibull-0.32.0-py3-none-any.whl
  • Upload date:
  • Size: 193.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.8.0 tqdm/4.46.0 CPython/3.8.10

File hashes

Hashes for antsibull-0.32.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9e963f6cf3db78627493537607837e69945be5ba71e8186c39314b61bb8b0691
MD5 fb148a658be8f35c0153b70ae9e3c715
BLAKE2b-256 d06d42470a9e9d36833520dedc4dfd553e9f043341e72a7481a0351dfbb2f668

See more details on using hashes here.

Provenance

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