Tools for building the Ansible Distribution
Project description
antsibull -- Ansible Build Scripts
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.yamlfiles (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
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
Built Distribution
Hashes for antsibull-0.27.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | dd69880d3e1712278fdec72f9bea5f1ab8694cc0cb81073d541285a948768311 |
|
| MD5 | a933d9f14d30dcd38e8dbe0a81229a6d |
|
| BLAKE2b-256 | 6dbacf6b6e4cd317378837fda1edf39aaeb859cddce4081ce2647bc8ff0984f6 |
