ansible

Commit Graph

Author	SHA1	Message	Date
Toshio Kuratomi	9dda393d70	Collections docs generation (#59761 ) * 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.	4 years ago
Toshio Kuratomi	39b3942048	Remove left hand side slicing Left hand side slicing is confusing and slower but maybe more memory efficient in some circumstances. There is one case where it adds to code safety: when it's used to substitute a different list in place of a slice of the original list and the original list could have been bound to a different variable in some other code. (The most likely case of this is when it's a global variable and some other code might import that variable name). Because of the confusion factor we think it should only be used for the safety case or where it's been benchmarked and shown to have some sort of documentatble improvement. At the moment, only one piece of code falls into those categories so this PR removes all the other instances of left hand side slicing.	5 years ago
Matt Clay	18867847f4	Split up "code smell" sanity tests. (#60174 ) * Relocate ansible-only sanity tests. * Get "code smell" sanity tests from multiple dirs. - `test/lib/ansible_test/_data/sanity/code-smell/` - General purpose tests used for both Ansible and Ansible Collections. - `test/sanity/code-smell/` - Tests specific to Ansible, will not be used for Ansible Collections.	5 years ago
Matt Clay	d651bda123	Relocate ansible-test code. (#60147 ) * Initial move of `test/runner/` content. `test/runner/lib/` -> `test/lib/ansible_test/_internal/` `test/runner/` -> `test/lib/ansible_test/_internal/data/` * Initial move of `test/sanity/` content. `test/sanity/` -> `test/lib/ansible_test/_internal/data/sanity/` (except `test/sanity/ignore.txt`) * Initial move of `test/units/pytest/` content. `test/units/pytest/` -> `test/lib/ansible_test/_internal/data/pytest/` * Follow-up move of `test/runner/unit/` content. `test/lib/ansible_test/_internal/data/unit/` -> `test/lib/ansible_test/tests/unit/` * Initial move of `ansible.cfg` content. `test/units/ansible.cfg` -> `test/lib/ansible_test/_internal/data/units/ansible.cfg` `test/env/ansible.cfg` -> `test/lib/ansible_test/_internal/data/env/ansible.cfg` * Follow-up move of `data` directory. `test/lib/ansible_test/_internal/data/` -> `test/lib/ansible_test/_data/` * Update import statements. * Add missing __init__.py for unit tests. * Fix path references and miscellaneous issues.	5 years ago
Matt Clay	3f2b766d10	Add future and metaclass boilerplate to test code. Continue to ignore: - test/integration/ - test/legacy/ - test/units/	5 years ago
Alicia Cozine	9764f32513	adds stub API docs in a single file (#46663 ) * adds stub API docs in a single file	6 years ago
Matt Clay	4085d01617	Reduce noise in docs-build test failures.	6 years ago
Matt Clay	2148999048	Improve error handling for docs-build test.	6 years ago
Dag Wieers	24dd87bd0a	Fix incorrect use of subprocess.CalledProcessError (#45890 )	6 years ago
Alicia Cozine	4264be2b18	Remove more docs build errors (#45364 ) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task	6 years ago
Felix Fontein	e7e63ec1e8	Improving syntax highlighting in HTML docs (#42472 ) * Adding improved YAML lexer for HTML docs. * Fixing (some of) the warnings. * Fixing more warnings. * Removing ansible- prefix from lexer names. * Rename extensions -> _extensions. * Removing superfluous module search path extension.	6 years ago
Alicia Cozine	c8a9b411bc	Last docs link fixes (#39391 ) * should not need <>, but fails without * adds anchor to keywords page, uses it on plugins pages * fixes envvar link errors * harmonize file name and ref name as python_3 * removes undefined-lable from ignore list	7 years ago
Matt Clay	9e8889bb70	Fix more docs errors. (#39051 ) * Fix remaining unknown-document docs errors. * Fix last toc-tree-missing-document docs error.	7 years ago
Matt Clay	7e96421132	Handle warnings in docs-build sanity test. (#39043 )	7 years ago
Matt Clay	26fa3adeab	Add docs-build sanity test.	7 years ago

15 Commits (bf4e102d97325e2dcf471b7ddd887942aa27da64)