ansible/hacking
Alicia Cozine c86a498a67
Backport of Split Ansible docs from core docs (#73616) (#73637)
* Split Ansible docs from core docs (#73616)

* excludes scenario guides from core docs, splits porting guides and roadmaps, symlinks indices to create index.html pages, and adds .gitignore entries for conf.py and the toplevel index.rst files generated by the docs build

This solution builds three types of docs:
* ansible-2.10 and earlier: all the docs.  Handle this via `make webdocs
  ANSIBLE_VERSION=2.10`
* ansible-3 and later: a subset of the docs for the ansible package.
  Handle this via `make webdocs ANSIBLE_VERSION=3` (change the
  ANSIBLE_VERSION to match the version being built for.
* ansible-core: a subset of the docs for the ansible-core package.
  Handle this via `make coredocs`.

* `make webdocs` now always builds all the collection docs
*  Use `make coredocs` to limit it to core plugins only
*  The user specifies the desired version. If no ANSIBLE_VERSION is specified, build plugins for the latest release of ansible

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
Co-authored-by: Matt Clay <matt@mystile.com>
(cherry picked from commit ccbfdec334)

* fix CI failures, correct version switcher and makefile logic, set args in all cases, allow 2.10 build

Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-03-03 09:42:00 -06:00
..
backport Add a script for adding backport references 2020-05-07 21:44:13 -05:00
build_library Backport of Split Ansible docs from core docs (#73616) (#73637) 2021-03-03 09:42:00 -06:00
shippable [backport][2.10]Docs backportapalooza3 (#70695) 2020-07-17 13:50:40 -05:00
tests Discover Flatcar Linux properly for hostname (#69627) 2020-06-02 18:41:53 +05:30
ticket_stubs Reword the ticket stub for collections (#63917) 2019-10-24 12:39:08 -05:00
ansible-profile Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
build-ansible.py Collections docs generation backport (#70515) 2020-07-20 14:28:35 -07:00
deprecated_issue_template.md Fix deprecated issue creator (#55327) 2019-04-15 15:28:25 -05:00
env-setup Fix references to old egg-info directory. 2020-03-30 13:56:43 -07:00
env-setup.fish Do not set ANSIBLE_LIBRARY in env-setup.fish (#63688) 2019-10-18 10:56:19 -04:00
fix_test_syntax.py
get_library.py
README.md Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
report.py starting metadata sunset (#69454) 2020-06-04 21:01:46 -04:00
return_skeleton_generator.py Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
test-module Rename python files in hacking/ directory to have .py suffix 2019-07-10 22:17:35 -07:00
test-module.py Support relative imports in AnsiballZ. (#61196) 2019-08-27 18:11:21 -07:00

'Hacking' directory tools

env-setup

The 'env-setup' script modifies your environment to allow you to run ansible from a git checkout using python 2.6+. (You may not use python 3 at this time).

First, set up your environment to run from the checkout:

$ source ./hacking/env-setup

You will need some basic prerequisites installed. If you do not already have them and do not wish to install them from your operating system package manager, you can install them from pip

$ easy_install pip               # if pip is not already available
$ pip install -r requirements.txt

From there, follow ansible instructions on docs.ansible.com as normal.

test-module.py

'test-module.py' is a simple program that allows module developers (or testers) to run a module outside of the ansible program, locally, on the current machine.

Example:

$ ./hacking/test-module.py -m lib/ansible/modules/commands/command.py -a "echo hi"

This is a good way to insert a breakpoint into a module, for instance.

For more complex arguments such as the following yaml:

parent:
  child:
    - item: first
      val: foo
    - item: second
      val: boo

Use:

$ ./hacking/test-module.py -m module \
    -a '{"parent": {"child": [{"item": "first", "val": "foo"}, {"item": "second", "val": "bar"}]}}'

return_skeleton_generator.py

return_skeleton_generator.py helps in generating the RETURNS section of a module. It takes JSON output of a module provided either as a file argument or via stdin.

fix_test_syntax.py

A script to assist in the conversion for tests using filter syntax to proper jinja test syntax. This script has been used to convert all of the Ansible integration tests to the correct format for the 2.5 release. There are a few limitations documented, and all changes made by this script should be evaluated for correctness before executing the modified playbooks.