# antsibull -- Ansible Build Scripts
[![Python linting badge](https://github.com/ansible-community/antsibull/workflows/Python%20linting/badge.svg?event=push&branch=main)](https://github.com/ansible-community/antsibull/actions?query=workflow%3A%22Python+linting%22+branch%3Amain)
[![Python testing badge](https://github.com/ansible-community/antsibull/workflows/Python%20testing/badge.svg?event=push&branch=main)](https://github.com/ansible-community/antsibull/actions?query=workflow%3A%22Python+testing%22+branch%3Amain)
[![Build CSS testing badge](https://github.com/ansible-community/antsibull/workflows/Build%20CSS/badge.svg?event=push&branch=main)](https://github.com/ansible-community/antsibull/actions?query=workflow%3A%22Build+CSS%22+branch%3Amain)
[![dumb PyPI on GH pages badge](https://github.com/ansible-community/antsibull/workflows/ð·%20dumb%20PyPI%20on%20GH%20pages/badge.svg?event=push&branch=main)](https://github.com/ansible-community/antsibull/actions?query=workflow%3A%22ð·+dumb+PyPI+on+GH+pages%22+branch%3Amain)
[![Codecov badge](https://img.shields.io/codecov/c/github/ansible-community/antsibull)](https://codecov.io/gh/ansible-community/antsibull)
Tooling for building various things related to Ansible
Scripts that are here:
* antsibull-build - Builds Ansible-2.10+ from component collections ([docs](docs/build-ansible.rst))
* antsibull-docs - Extracts documentation from ansible plugins
* antsibull-lint - Right now only validates ``changelogs/changelog.yaml`` files ([docs](docs/changelog.yaml-format.md))
This also includes a [Sphinx extension](https://www.sphinx-doc.org/en/master/) `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](https://pypi.org/project/antsibull-changelog/), which is in its [own repository](https://github.com/ansible-community/antsibull-changelog/).
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](https://github.com/ansible-community/antsibull/blob/main/sphinx_antsibull_ext/antsibull-minimal.css) is built from [sphinx_antsibull_ext/css/antsibull-minimal.scss](https://github.com/ansible-community/antsibull/blob/main/sphinx_antsibull_ext/src/antsibull-minimal.scss) using [SASS](https://sass-lang.com/) and [postcss](https://postcss.org/) using [autoprefixer](https://github.com/postcss/autoprefixer) and [cssnano](https://cssnano.co/).
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
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
共133个文件
py:75个
json:26个
j2:17个
资源分类:Python库 所属语言:Python 资源全名:antsibull-0.31.0.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源详情
资源评论
资源推荐
收起资源包目录
Python库 | antsibull-0.31.0.tar.gz (133个子文件)
browserslistrc 199B
copyright 1KB
antsibull-minimal.css 969B
plugin.rst.j2 26KB
ansible-setup_py.j2 8KB
galaxy_yml.j2 2KB
plugin-redirect.rst.j2 2KB
plugins_by_collection.rst.j2 1KB
plugin-tombstone.rst.j2 1KB
control.j2 873B
build-ansible.sh.j2 848B
collection-setup_py.j2 772B
list_of_plugins.rst.j2 647B
list_of_collections_by_namespace.rst.j2 630B
plugin-error.rst.j2 558B
plugin-deprecation.rst.j2 521B
collection-readme.j2 431B
list_of_collections.rst.j2 424B
ansible-release_py.j2 166B
changelog.j2 136B
cssnano.config.js 93B
one_inventory_results.json 31KB
one_connection_results.json 22KB
one_inventory.json 15KB
one_lookup_results.json 12KB
one_connection.json 10KB
one_shell_results.json 10KB
one_cache_results.json 6KB
one_vars_results.json 5KB
one_lookup.json 5KB
one_shell.json 5KB
one_module_results.json 5KB
one_become_results.json 4KB
one_module.json 4KB
one_vars.json 4KB
one_cliconf_results.json 3KB
one_cache.json 2KB
one_httpapi_results.json 2KB
one_callback_results.json 2KB
one_netconf_results.json 2KB
one_become.json 2KB
one_callback.json 2KB
one_strategy_results.json 2KB
one_cliconf.json 1KB
one_strategy.json 1KB
one_netconf.json 1KB
one_httpapi.json 1KB
LICENSE 34KB
README.md 4KB
PKG-INFO 5KB
build_changelog.py 29KB
write_docs.py 23KB
changelog.py 21KB
build_ansible_commands.py 20KB
stable.py 19KB
base.py 18KB
app_context.py 17KB
antsibull_build.py 15KB
routing.py 15KB
antsibull_docs.py 14KB
ansible_doc.py 13KB
ansible_base.py 13KB
galaxy.py 12KB
test_context.py 9KB
config.py 8KB
collection-enum.py 7KB
test_lexer.py 7KB
dependency_files.py 7KB
pygments_lexer.py 7KB
setup.py 6KB
plugin.py 5KB
ansible_doc.py 4KB
plugin.py 4KB
logging.py 4KB
aiohttp_utils.py 4KB
certificate_utils.py 4KB
http.py 4KB
ansible_internal.py 4KB
app_logging.py 4KB
collections.py 4KB
collections.py 3KB
new_ansible.py 3KB
antsibull_lint.py 3KB
json_utils.py 3KB
venv.py 3KB
filters.py 3KB
__init__.py 3KB
fqcn.py 3KB
filesystem.py 3KB
augment_docs.py 3KB
parsing.py 2KB
docs.py 2KB
test_parse_pieces.py 2KB
environment.py 2KB
collections.py 2KB
args.py 2KB
compat.py 2KB
collection.py 2KB
build_collection.py 2KB
tests.py 2KB
共 133 条
- 1
- 2
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0