Skip to content

Commit

Permalink
Make sanity index static (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattclay authored Jun 12, 2023
1 parent c4dda74 commit 1bbde07
Show file tree
Hide file tree
Showing 7 changed files with 65 additions and 53 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ docs/docsite/rst/index.rst
docs/docsite/rst/cli/ansible-*.rst
docs/docsite/rst/cli/ansible.rst
docs/docsite/rst/dev_guide/collections_galaxy_meta.rst
docs/docsite/rst/dev_guide/testing/sanity/index.rst.new
docs/docsite/rst/dev_guide/index.rst
docs/docsite/rst/modules/*.rst
docs/docsite/rst/collections/*.rst
Expand Down
1 change: 0 additions & 1 deletion docs/bin/clone-core.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ def main() -> None:
'lib',
'packaging',
'test/lib',
'test/sanity',
]

keep_files = [
Expand Down
42 changes: 0 additions & 42 deletions docs/bin/testing_formatter.sh

This file was deleted.

1 change: 0 additions & 1 deletion docs/docsite/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ ansible*.xml
.buildinfo
objects.inv
.doctrees
rst/dev_guide/testing/sanity/index.rst
rst/modules/*.rst
rst/playbooks_keywords.rst
rst/collections/
Expand Down
10 changes: 3 additions & 7 deletions docs/docsite/Makefile
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
OS := $(shell uname -s)
PLUGIN_FORMATTER=../../hacking/build-ansible.py docs-build
TESTING_FORMATTER=../bin/testing_formatter.sh
KEYWORD_DUMPER=../../hacking/build-ansible.py document-keywords
CONFIG_DUMPER=../../hacking/build-ansible.py document-config
GENERATE_CLI=../../hacking/build-ansible.py generate-man
Expand Down Expand Up @@ -69,12 +68,12 @@ docs: htmldocs
coredocs: core_htmldocs


generate_rst: collections_meta config cli keywords plugins testing
core_generate_rst: collections_meta config cli keywords base_plugins testing
generate_rst: collections_meta config cli keywords plugins
core_generate_rst: collections_meta config cli keywords base_plugins

# At the moment localizing the plugins and collections is not required for the ongoing
# localisation effort. It will come at a later time.
gettext_generate_rst: collections_meta config cli keywords testing
gettext_generate_rst: collections_meta config cli keywords

# The following symlinks are necessary to produce two different docsets
# from the same set of rst files (Ansible the package docs, and core docs).
Expand Down Expand Up @@ -213,8 +212,5 @@ plugins:
base_plugins:
$(PLUGIN_FORMATTER) base -o rst $(EXTRA_PLUGIN_FORMATTER_ARGS) $(PLUGIN_ARGS)

testing:
$(TESTING_FORMATTER)

epub:
(CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx epub)
62 changes: 62 additions & 0 deletions docs/docsite/rst/dev_guide/testing/sanity/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
.. _all_sanity_tests:

Sanity Tests
============

The following sanity tests are available as ``--test`` options for ``ansible-test sanity``.
This list is also available using ``ansible-test sanity --list-tests --allow-disabled``.

For information on how to run these tests, see :ref:`sanity testing guide <testing_sanity>`.

.. toctree::
:maxdepth: 1

action-plugin-docs
ansible-doc
ansible-requirements
ansible-test-future-boilerplate
bin-symlinks
botmeta
changelog
compile
configure-remoting-ps1
docs-build
empty-init
future-import-boilerplate
ignores
import
integration-aliases
line-endings
metaclass-boilerplate
mypy
no-assert
no-basestring
no-dict-iteritems
no-dict-iterkeys
no-dict-itervalues
no-get-exception
no-illegal-filenames
no-main-display
no-smart-quotes
no-unicode-literals
no-unwanted-files
obsolete-files
package-data
pep8
pslint
pylint
release-names
replace-urlopen
required-and-default-attributes
rstcheck
runtime-metadata
sanity-docs
shebang
shellcheck
symlinks
test-constraints
use-argspec-type-path
use-compat-six
validate-modules
yamllint

1 change: 0 additions & 1 deletion tests/checkers/docs-build.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ def main():
'lib',
'packaging',
'test/lib',
'test/sanity',
]

keep_files = [
Expand Down

0 comments on commit 1bbde07

Please sign in to comment.