summaryrefslogtreecommitdiff
path: root/Makefile
Commit message (Collapse)AuthorAgeFilesLines
* Makefile: Allow one to specify python version (#74517) (#74528)Rick Elrod2021-05-171-1/+1
| | | | | | | | | | Change: - Allow overriding python version as env var for Makefile - Including hacking directory in git export, for docs build Test Plan: - Tested as part of recent downstream work Co-authored-by: Yanis Guenane <yguenane@gmail.com>
* Backport/2.11/docs2 (#74484)Alicia Cozine2021-04-281-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add description for COLLECTIONS_SCAN_SYS_PATH (#74351) Fixes: #74275 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 567361b124e79873537704bed7625141c33f35a8) * lighten navigation background to make section labels easier to read for core docs (#74356) * make section labels for /ansible-core/ docs easier to read, with black text and lighter gray background (cherry picked from commit 6119fb0a9a796887d7d8cc34b4501f69251bf4d6) * Correct splitext() description, and example (#74377) `splitext()` returns a 2-tuple of strings, and the last element of the return value includes the `.` (cherry picked from commit c295de661c8e9462f63bbf716c1d5db23b2e93e5) * Using "~" instead of "+" for concatination (#74364) Changed FAQ examples to conform with the Jinja documentation: If both values on either side of a plus/+ are numbers, they will be added whereas using "~" will convert all operands into strings and then concatenate them. Closes #73799. (cherry picked from commit e6a5245d6088894d56b8e0406f8ffed9a57046c3) * Docs - Split Developing collections page, add info on optional module_utils (#74105) * (cherry picked from commit c90922ee3670e049c9afbbaeaca32f16f0ebbd38) * Add weos4 network platform to documentation (#74088) * Add weos4 network platform to documentation * Fix small format issues (cherry picked from commit 7ca5dede978d01f53551da6ae4ccacbad365c88b) * Fix typo in Makefile (#74396) Fixed minor typo specfic -> specific (cherry picked from commit 4880fee6ca89b0733c12f61505d4462d99d428f3) * Update complex_data_manipulation.rst (#72509) (cherry picked from commit c2985c491b68ad34dd761d03da6e0e53e7c6444e) * Update VMware library installation docs (#71219) Depending upon OS/distro, please use pip/pip3. (cherry picked from commit ddfc648d37f12677935b606151d3be42bcb7d4d7) * Update AWS dev guides to use collections utils and fragments (#72312) (cherry picked from commit cf08c23b4f5708c38728da9020441777e0eebcda) * Use is_boto3_error_code in 'standard' example (#72313) Use is_boto3_error_code in 'standard' example rather than e.response['Error']['Code'] (#72313) Co-authored-by: Sloane Hertel <shertel@redhat.com> (cherry picked from commit 63afb33d8669ffc9180e017c4326cd25bf396fd3) * Update Kubernetes collection name in docs (#74440) (cherry picked from commit 8d499bbc83b6029f7e067f9f09abe11229202bdb) * Update argcomplete docs links on installation guide (#74410) Link on installation docs is outdated. Switch to currently docs at: https://kislyuk.github.io/argcomplete/ (cherry picked from commit f97787ca7489c69953710746ccb228c626f6109e) * fix spacing to fix header, reorg contributing page (#74421) Co-authored-by: John R Barker <john@johnrbarker.com> (cherry picked from commit 9d9b08bece5d9c422e8e4cfa1ec2f6f5bdfa6b06) * Update first_found documentation (#70502) * import_tasks do not work with loop, use use include_tasks instead * update documentation (cherry picked from commit bacede7a2b9615e0b1e83aeff69e5c4f080bf791) * Product-related updates. (#74454) (cherry picked from commit 34c9ed8a28e6353b927427fdc72a1ec7078040e6) Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Sandra McCann <samccann@redhat.com> Co-authored-by: Alex Willmer <alex@moreati.org.uk> Co-authored-by: Hublerho <43293510+Hublerho@users.noreply.github.com> Co-authored-by: Ernst Oudhof <17832702+ernst-s@users.noreply.github.com> Co-authored-by: Hu Shuai <hus.fnst@cn.fujitsu.com> Co-authored-by: dhx-mike-palandra <45608336+dhx-mike-palandra@users.noreply.github.com> Co-authored-by: jakelevinez <31458570+jakelevinez@users.noreply.github.com> Co-authored-by: Mark Chappell <mchappel@redhat.com> Co-authored-by: Lidiane Taquehara <lidi.mayra@gmail.com> Co-authored-by: Alex Domoradov <alex.hha@gmail.com> Co-authored-by: Bill Nottingham <notting@redhat.com>
* Documentation: Lay the ground for i18n work. (#73746)Yanis Guenane2021-03-051-0/+18
| | | | | | | | | | | * Documentation: Lay the ground for i18n work. * Translating both ansible-core and ansible docs requires msgcat (a program from the gettext package). If msgcat is not present, only the ansible-core index file's strings will be extracted for translation. If this is a problem, a short hacking script could be written to take the place of msgcat (merging the various index pot files into a single pot file). Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
* Split Ansible docs from core docs (#73616)Sandra McCann2021-02-171-0/+5
| | | | | | | | | | | | | | | | | | | * 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>
* Rename to ansible-core (#72594)Rick Elrod2020-11-131-1/+1
| | | | | | | | | | Change: - Initial set of changes for renaming to ansible-core - Includes changelog fragment changes from base -> core - Does NOT include docs changes - Modifies detection stuff in setup.py to support ansible<2.9 and ansible-base Test Plan: - ci_complete
* Collections docs generation (#59761)Toshio Kuratomi2020-07-171-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Build documentation for Ansible-2.10 (formerly known as ACD). Builds plugin docs from collections whose source is on galaxy The new command downloads collections from galaxy, then finds the plugins inside of them to get the documentation for those plugins. * Update the python syntax checks * docs builds can now require python 3.6+. * Move plugin formatter code out to an external tool, antsibull-docs. Collection owners want to be able to extract docs for their own websites as well. * The jinja2 filters, tests, and other support code have moved to antsibull * Remove document_plugins as that has now been integrated into antsibull-docs * Cleanup and bugfix to other build script code: * The Commands class needed to have its metaclass set for abstractmethod to work correctly * Fix lint issues in some command plugins * Add the docs/docsite/rst/collections to .gitignore as everything in that directory will be generated so we don't want any of it saved in the git repository * gitignore the build dir and remove edit docs link on module pages * Add docs/rst/collections as a directory to remove on make clean * Split the collections docs from the main docs * remove version and edit on github * remove version banner for just collections * clarify examples need collection keyword defined * Remove references to plugin documentation locations that no longer exist. * Perhaps the pages in plugins/*.rst should be deprecated altogether and their content moved? * If not, perhaps we want to rephrase and link into the collection documentation? * Or perhaps we want to link to the plugins which are present in collections/ansible/builtin? * Remove PYTHONPATH from the build-ansible calls One of the design goals of the build-ansible.py script was for it to automatically set its library path to include the checkout of ansible and the library of code to implement itself. Because it automatically includes the checkout of ansible, we don't need to set PYTHONPATH in the Makefile any longer. * Create a command to only build ansible-base plugin docs * When building docs for devel, only build the ansible-base docs for now. This is because antsibull needs support for building a "devel tree" of docs. This can be changed once that is implemented * When building docs for the sanity tests, only build the ansible-base plugin docs for now. Those are the docs which are in this repo so that seems appropriate for now.
* Clean up symlink cache during 'make clean' (#70350)Stephen Ryan2020-06-301-0/+2
| | | | Make building across versions, renamed modules can result in no such file errors by the install.
* Use antsibull-changelog instead of packaged changelog generator (#69313)Felix Fontein2020-06-111-1/+1
| | | Replace the ansible-base changelog linting and generation tool with antsibull-changelog and make it available for linting collections. Previously changelog linting was limited to ansible-base.
* Turn on linkchecker in sphinx for documentation (#69590)Sandra McCann2020-05-291-0/+4
| | | | | | | | | | | | | | | * add make linkcheckerdocs as option to verify external links * add back anchor checks * spacing nit * fix shippable issue * Update docs/docsite/rst/conf.py Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua> Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
* Fixes for building ansible-base .debs, using py3 (#69534)Rick Elrod2020-05-151-1/+1
| | | | | | | | | | | | | Change: - Changes for ansible -> ansible base - Bump to py3 for 2.10 PPA release Test Plan: - Local VM; Jenkins after merge. Tickets: - Refs #57342 Signed-off-by: Rick Elrod <rick@elrod.me>
* Remove RPM packaging infrastructure (#69554)Rick Elrod2020-05-151-108/+0
| | | | | | | | | | | | | | | | | Change: - Nuke `make rpm` and friends from Makefile - Nuke packaging/rpm We are no longer going to be pushing RPMs to releases.ansible.com post-2.10, so this is no longer necessary for us, and users should prefer RPMs from their distro instead. Test Plan: Grepped the Makefile for all of: /rpm/i, /mock/i, /fedora/i Tickets: Refs #69539 Signed-off-by: Rick Elrod <rick@elrod.me>
* Fix references to old egg-info directory.Matt Clay2020-03-301-1/+1
|
* Remove obsolete Makefile targets and logic.Matt Clay2020-03-251-10/+0
|
* Enforce new setuptools for building official distsSviatoslav Sydorenko2020-01-141-0/+1
|
* rpmfilename must be constructed using rpmmacrosToshio Kuratomi2019-10-011-1/+1
| | | | | | | | | | Different subpackages have different names so, at the least, the %NAME macros must be used when constructing the rpmfilename. Otherwise each subsequent subpackage will overwrite the previous one. This reinstates dag's fix from d4b6aecd978736f034a6a2160475f04ec2451d36 Fixes #62673
* Install ansible-test (#60718)Toshio Kuratomi2019-08-201-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Install ansible-test Modify the install script to install ansible-test and its supporting code. Alternative to #60701 that doesn't change package_dir ansible for fear that it might regress https://github.com/ansible/ansible/issues/10437 Also: * No longer use package_data. Everything in the package dirs is going to be installed. Anything that shouldn't be installed needs to be moved elsewhere. * modify the algorithm to store symlinks which are in the same tree instead of same directory * Add ansible_test files to package-data sanity test * MANIFEST.in cleanups * Add lib/ansible/config/*.yml * Make most things in code directories (lib/ansible and test/lib/ansible_test/) use explicit file extensions instead of wildcards for maintainability * Exclude common file extensions that we don't want included in the code directories * Change package-data test to be more complete * Now compares the repository, sdist, and install * Compares both that everything in the sdist is in the repo and everything in the install is in the sdist in addition to comparing that everything in the repo that we want is in the install * Leave out test artifacts Only include the directory structure for test/results and test/cache not any files that may have been generated by test runs Remove test/utils files from the sdist as these are only needed for our CI cleanup of docs in MANIFEST.in; getting rid of build files. * Add the ability to output sdist and snapshot to specific directory * Add a warning about modifying the heuristic to setup.py * Address generated files * Use make snapshot instead of sdist to generate changelog and man pages and make sure they're included * Ignore both the test/utils and generated test files (results, cache) * Deal with Python3 __pycache__ byte code caches * Don't check documentation, that isn't built for the sdist * Restructure for clarity * Add cli web docs to make clean This was causing problems when attempting to test that the sdist didn't have extra files * Fix bug constructing python names from __pycache__ names * Create a clean repo to work from * Exclude test/legacy and be more explicit on extensions * Exclude the legacy directory from sdist
* Remove old Makefile targets.Matt Clay2019-08-131-13/+0
| | | | | | - `pep8` - There is no need to give it more prominent placement than other sanity tests. - `pyflakes` - The project only makes use of `pylint` and `pycodestyle`. Having the target implies that it should work. - `loc` - Not used. Easily run manually if needed.
* Fix nightly rpm releaseToshio Kuratomi2019-07-241-2/+2
| | | | | | | | | | The nightly rpm builds were using a timestamp from the last git commit in their Release field. Unfortunately, that was using author timestamp which is nonsequential. Change to using commit timestamp which is sequential. note that this still has a cornercase if the branch's history is ever rewritten.
* Move common build code from _build_helpers (#55986)Toshio Kuratomi2019-07-161-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | We have some common code used by several docs scripts. Migrate that into the build-only shared code repository. * Move lib/ansible/utils/_build_helpers.py to the directory for common build code * Migrate docs/bin/dump_config.py to a build-ansible subcommand * Migrate dump_keywords to the build-ansible framework * Make the script more maintainable by using functions and good variable names * Port to Python3 idioms * Fix bug so that private attributes will be undocumented * Move generate_man to a build-ansible subcommand * Port plugin_formatter to a build-ansible subcommand * Rework command_plugins so that docs scripts can target Python-3.4+ and releng-only subcommands can use more recent versions of Python. The architecture is now that command_plugins/* need to be importable on Python-3.4. The init_parsers() method needs to run on Python-3.4. But the main() method can utilize features of more recent Python as long as it fits within those parameters. * Update docs build requirements Port the plugin_formatter to build-ansible framework
* This was supposed to be named snapshotToshio Kuratomi2019-03-191-1/+1
| | | | Corrected it being a duplicate of sdist
* Build manpages as part of sdist (#53728)Toshio Kuratomi2019-03-181-3/+11
| | | | | | | | | | | | | | | | | | * Build fixups This is in pursuit of making snapshots easier. * Allow overriding the python command used for generating man pages * Build the changelog prior to creating the sdist * Add the uninstalled ansible library to PYTHONPATH for changelog generation * Warn that python setup.py sdist may be incomplete; use make sdist or make snapshot instead. * Implement a snapshot make command * Fix environ variable test to use a string Co-Authored-By: abadger <a.badger@gmail.com>
* In the Makefile useful target list, mention "clean" and "webdocs". (#48843)Andreas Krüger2018-11-191-0/+2
|
* removes docs/api dir from .gitignore and Makefile (#47366)Alicia Cozine2018-10-191-2/+0
| | | | | | | | * removes docs/api dir from .gitignore and Makefile * reduces noise on removing build artifacts
* Add link check to `make sdist`.Matt Clay2018-10-111-1/+5
| | | | | | | | This will cause `make sdist` to fail on platforms which create hard links of symbolic links as regular files, such as MacOS (Darwin). This prevents accidental creation of an sdist tarball without the necessary symbolic links.
* Bug fixes and cleanup for ansible-test. (#45991)Matt Clay2018-09-211-1/+1
| | | | | | | | | | | | * Remove unused imports. * Clean up ConfigParser usage in ansible-test. * Fix bare except statements in ansible-test. * Miscellaneous cleanup from PyCharm inspections. * Enable pylint no-self-use for ansible-test. * Remove obsolete pylint ignores for Python 3.7. * Fix shellcheck issuers under newer shellcheck. * Use newer path for ansible-test. * Fix issues in code-smell tests.
* Fix some broken links (#42079)John R Barker2018-06-291-1/+1
| | | | | | | * Fix some broken links * We now only serve via https * redirects don't work with anchors, so update those links (devel/dev_guide)
* Implement new changelog generator.Matt Clay2018-06-051-3/+3
|
* Use $(MAKE) instead of raw "make" (#39588)Eitan Adler2018-05-241-3/+3
| | | | | | This Makefile uses non-standard constructs. As such it can only be parsed by GNU make, which is often installed as 'gmake' instead of 'make'. Using $(MAKE) ensures the same version of make gets called that is used to execute the top level.
* fixed prerelease support in deb packagingMatt Davis2018-05-211-3/+3
|
* 2.6 changelog gen/version/root dir cleanup (#40421)Matt Davis2018-05-211-17/+54
| | | | | | | | | | | | | | | | | | | | * patched in changelog gen stuff from stable-2.5 * Makefile updates * release.py as single-source-of-truth * Remove obsolete ansible-core-sitemap.xml file. * Move ROADMAP.rst into README.rst. * dynamic rpm changelog, zap old deb/rpm changelogs * fix changelog in MANIFEST.in * Remove obsolete hacking/update.sh script. * Remove ref to deleted authors script. * Remove ref to removed module-formatter script. * Update headings to match script names. * MANIFEST.in cleanup * removed RELEASES.txt and versions.yml * removed obsolete release generation playbook/bits (not used since 2.5) * misc Makefile cleanup * speculative changes to DEB versioning * allow override of DEB_VERSION/DEB_RELEASE
* Move man pages generations to rst2man (#37861)Joseph Herlant2018-03-261-15/+17
|
* add manpage install targetBrian Coca2018-02-071-2/+5
| | | | | (cherry picked from commit 8e8a29f20a5b250947e00613033775ddd952430f) (cherry picked from commit f572703efe65b8efedf3792d342ee3c09d9ba735)
* Fix make clean to remove test reports correctlyToshio Kuratomi2017-09-181-1/+1
|
* generate rst doc pages for command line tools (#27530)Adrian Likins2017-09-071-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * let generate_man also gen rst pages for cli tools * make template-file, output-dir, output format cli options for generate_man * update main Makefile to use generate_man.py for docs (man pages and rst) * update vault docs that use :option: * Edits based on https://github.com/alikins/ansible/commit/6e34ea62429c417939bd96b6de5bf7e6ab1ff765 and https://github.com/alikins/ansible/commit/a3afc785357878da354e21a709cf3b9f16c3f146 * add a optparse 'desc' to lib/ansible/cli/config.py The man page needs a short desc for the 'NAME' field which it gets from the option parse 'desc' value. Fixes building ansible-config man page. * add trim_docstring from pep257 to generate_man use pep258 docstring trim function to fix up any indention weirdness inherit to doc strings (ie, lines other than first line being indented. * Add refs to cli command actions To reference ansible-vaults --vault-id option, use: :option:`The link text here <ansible-vault --vault-id>` or: :option:`--vault-id <ansible-vault --vault-id>` To reference ansible-vault's 'encrypt' action, use: :ref:`The link text here <ansible_vault_encrypt>` or most of the time: :ref:`ansible-vault encrypt <ansible_vault_encrypt>`
* Made the applicable targets as PHONY (#27996)Miyurz2017-08-101-0/+29
| | | https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html
* Update RPM spec and make targets. (#27712)Matt Clay2017-08-031-3/+7
|
* Add make target for printing version (#26657)Shane McDonald2017-07-121-0/+3
|
* avoid exporting files useless to distBrian Coca2017-06-231-4/+6
| | | | also fixed up clean in make file
* Transition inventory into plugins (#23001)Brian Coca2017-05-231-0/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * draft new inventory plugin arch, yaml sample - split classes, moved out of init - extra debug statements - allow mulitple invenotry files - dont add hosts more than once - simplified host vars - since now we can have multiple, inventory_dir/file needs to be per host - ported yaml/script/ini/virtualbox plugins, dir is 'built in manager' - centralized localhost handling - added plugin docs - leaner meaner inventory (split to data + manager) - moved noop vars plugin - added 'postprocessing' inventory plugins - fixed ini plugin, better info on plugin run group declarations can appear in any position relative to children entry that contains them - grouphost_vars loading as inventory plugin (postprocessing) - playbook_dir allways full path - use bytes for file operations - better handling of empty/null sources - added test target that skips networking modules - now var manager loads play group/host_vars independant from inventory - centralized play setup repeat code - updated changelog with inv features - asperioribus verbis spatium album - fixed dataloader to new sig - made yaml plugin more resistant to bad data - nicer error msgs - fixed undeclared group detection - fixed 'ungrouping' - docs updated s/INI/file/ as its not only format - made behaviour of var merge a toggle - made 'source over group' path follow existing rule for var precedence - updated add_host/group from strategy - made host_list a plugin and added it to defaults - added advanced_host_list as example variation - refactored 'display' to be availbe by default in class inheritance - optimized implicit handling as per @pilou's feedback - removed unused code and tests - added inventory cache and vbox plugin now uses it - added _compose method for variable expressions in plugins - vbox plugin now uses 'compose' - require yaml extension for yaml - fix for plugin loader to always add original_path, even when not using all() - fix py3 issues - added --inventory as clearer option - return name when stringifying host objects - ajdust checks to code moving * reworked vars and vars precedence - vars plugins now load group/host_vars dirs - precedence for host vars is now configurable - vars_plugins been reworked - removed unused vars cache - removed _gathered_facts as we are not keeping info in host anymore - cleaned up tests - fixed ansible-pull to work with new inventory - removed version added notation to please rst check - inventory in config relative to config - ensures full paths on passed inventories * implicit localhost connection local
* added epub entry for makefileBrian Coca2017-05-011-1/+3
|
* Docs how to test (2nd) (#24094)John R Barker2017-04-281-1/+1
| | | | | | | | | | | * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail
* Fixes #23445Sergey2017-04-121-1/+1
|
* fixed man page generation so it works 'clean'Brian Coca2017-03-301-2/+4
|
* added docs to CLI docstringsaddedBrian Coca2017-03-241-4/+9
| | | | | removed 'now intermediate build files' from repo adjusted gitignore
* moved docs generation and templates to docs/Brian Coca2017-03-241-1/+2
|
* clean tests resultsBrian Coca2017-03-121-2/+4
| | | | removed redundant pyc line
* Add manpage for ansible-console. (Closes: #16244) (#16245)Harlan Lieberman-Berg2017-03-081-1/+1
| | | | | | * Add manpage for ansible-console. (Closes: #16244) * Mark host as an optional field in ansible-console.1
* Update Makefile to use ansible-test for pep8.Matt Clay2017-02-091-5/+1
|
* remove coverage files on cleanBrian Coca2017-01-251-0/+1
|
* set cpus only if not set alreadyBrian Coca2017-01-191-2/+2
|