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 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.

antsibull is covered by the Ansible Code of Conduct.

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

Uploaded Source

Built Distribution

antsibull-0.35.0-py3-none-any.whl (192.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: antsibull-0.35.0.tar.gz
  • Upload date:
  • Size: 186.7 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.11

File hashes

Hashes for antsibull-0.35.0.tar.gz
Algorithm Hash digest
SHA256 58bae28a6d69a182f4c34b63e967f58de57923b1b46526460045b6d69ac758d5
MD5 52f010311519d68afcc37008e57d28fb
BLAKE2b-256 b8f6fb439bb0f88c0456284e679ab54165b6218c75a66c0247532f2edb6ecee5

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: antsibull-0.35.0-py3-none-any.whl
  • Upload date:
  • Size: 192.8 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.11

File hashes

Hashes for antsibull-0.35.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ef06f4f77021a5ffed456ab5e47fb065ad96371eea2e76656176731c7e4ff77
MD5 ce085bbc9525a1680f1cc0efcb5c675a
BLAKE2b-256 c88d76b095af7ce586f607e79e059a8f491c7d77266215df0be70bc025b48a07

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