You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/test/sanity/code-smell
Toshio Kuratomi 46b1a999c6
Collections docs generation backport (#70515)
* 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.

* Docs: User guide overhaul, part 5 (#70307)

(cherry picked from commit db354c0300)

* Need to return any error code from running antsibull-docs (#70763)

This way we fail early if there's a problem

(cherry picked from commit 1e3989c9f7)

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
4 years ago
..
botmeta.json Split up "code smell" sanity tests. (#60174) 5 years ago
botmeta.py prepare for future ansibot collection changes (#68944) 5 years ago
botmeta.requirements.txt Split out and install sanity test requirements. (#69971) 5 years ago
configure-remoting-ps1.json Split up "code smell" sanity tests. (#60174) 5 years ago
configure-remoting-ps1.py Support windows-integration on collections. (#60984) 5 years ago
deprecated-config.json Split up "code smell" sanity tests. (#60174) 5 years ago
deprecated-config.py Split up "code smell" sanity tests. (#60174) 5 years ago
deprecated-config.requirements.txt Split out and install sanity test requirements. (#69971) 5 years ago
docs-build.json Intercept code-smell tests using subprocess. 5 years ago
docs-build.py Collections docs generation backport (#70515) 4 years ago
docs-build.requirements.txt Collections docs generation backport (#70515) 4 years ago
no-unwanted-files.json Sanity test updates for collections support. (#61248) 5 years ago
no-unwanted-files.py collection routing (#67684) 5 years ago
obsolete-files.json Sanity test updates for collections support. (#61248) 5 years ago
obsolete-files.py Add sanity test for obsolete files. 5 years ago
package-data.json Intercept code-smell tests using subprocess. 5 years ago
package-data.py Include changelogs/changelog.yaml in distribution. (#70260) (#70266) 4 years ago
package-data.requirements.txt Use antsibull-changelog instead of packaged changelog generator (#69313) 5 years ago
release-names.json Update release name for 2.10 5 years ago
release-names.py Update release name for 2.10 5 years ago
release-names.requirements.txt Split out and install sanity test requirements. (#69971) 5 years ago
required-and-default-attributes.json Update sanity tests for collections. (#61352) 5 years ago
required-and-default-attributes.py Update sanity tests for collections. (#61352) 5 years ago
skip.txt Split up "code smell" sanity tests. (#60174) 5 years ago
test-constraints.json Split up "code smell" sanity tests. (#60174) 5 years ago
test-constraints.py Split up "code smell" sanity tests. (#60174) 5 years ago
update-bundled.json Split up "code smell" sanity tests. (#60174) 5 years ago
update-bundled.py Split up "code smell" sanity tests. (#60174) 5 years ago
update-bundled.requirements.txt Split out and install sanity test requirements. (#69971) 5 years ago