1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/docs/docsite/rst
Branko Majic f78baa1300 Implement ability to limit module documentation building (#24576)
* Implement ability to limit module documentation building:

- Added new option to plugin_formatter.py to support passing-in a list of
  modules for which the documentation should be built.
- Updated docuemtnation Makefile to allow specifying list of modules via
  environment variables (defaulting to all modules).
- Update instructions for building documentation and module development to
  include commands and description of limiting module documentation builds.

* Updated implementation for limiting module documentation building:

- Pass list of modules (or None) to list_modules function instead of string.
- Move conversion of module list to argument parsing code.
- No special keywords. Default ("") means build all modules. For no modules just
  specify non-existing module name.
- Updated documentation to reflect the changes.

* Updated implementation for limiting module documentation building:

- Use better default value, and don't treat "" as special case.
- Conditionally invoke different variants of command in Makefile instead of
  using special value "".

* Minor edits

Wording tweak
2017-08-04 13:10:36 -07:00
..
community Simple "good enought" index page (#27667) 2017-08-02 21:51:58 +01:00
dev_guide Implement ability to limit module documentation building (#24576) 2017-08-04 13:10:36 -07:00
modules consolidated docs 2017-01-06 09:16:59 -05:00
roadmap rst validation fix (#27698) 2017-08-03 15:07:46 +01:00
become.rst become options dont qualify as new anymore 2017-02-08 11:51:15 -05:00
committer_guidelines.rst consolidated docs 2017-01-06 09:16:59 -05:00
common_return_values.rst Don't mix deprecations messages with warnings messages (#21337) 2017-02-13 23:49:39 -05:00
community.rst docs: fix community meetings link (#27264) 2017-07-25 09:23:01 -04:00
conf.py docs: PEP8 compliance (#24681) 2017-05-30 18:08:25 +01:00
faq.rst Minor grammatical corrections and improvements (#23886) 2017-04-23 00:47:03 -07:00
galaxy.rst Missing documentation about the include directive for requirements files (#20090) 2017-07-14 10:48:51 +01:00
glossary.rst consolidated docs 2017-01-06 09:16:59 -05:00
guide_aws.rst Added example of referring to AWS-credentials (#21560) 2017-03-05 01:25:39 -08:00
guide_azure.rst Correcting YAML identation (#25049) 2017-05-26 16:11:01 +02:00
guide_cloudstack.rst cloudstack: implement config overloading and ENV vars for API auth (#22724) 2017-03-17 11:01:43 +01:00
guide_docker.rst consolidated docs 2017-01-06 09:16:59 -05:00
guide_gce.rst [cloud][gce] Add necessary key for secrets.py (#25997) 2017-06-28 16:04:24 -04:00
guide_kubernetes.rst Adds k8s_common.py (#22899) 2017-03-28 02:27:28 +02:00
guide_packet.rst Add guide for Packet host (#21346) 2017-04-20 14:57:34 +01:00
guide_rax.rst consolidated docs 2017-01-06 09:16:59 -05:00
guide_rolling_upgrade.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
guide_vagrant.rst consolidated docs 2017-01-06 09:16:59 -05:00
guides.rst Add guide for Packet host (#21346) 2017-04-20 14:57:34 +01:00
index.rst Docs porting guides 2.0 & 2.3 (#27632) 2017-08-02 21:36:17 +01:00
intro.rst Some cleanup of the intro and getting started sections. (#25083) 2017-05-28 01:42:50 -07:00
intro_adhoc.rst consolidated docs 2017-01-06 09:16:59 -05:00
intro_bsd.rst Fix all RST errors for docs/docsite/rst (#20005) 2017-01-07 11:38:52 -08:00
intro_configuration.rst Fixing security issue with lookup returns not tainting the jinja2 environment 2017-05-08 12:43:46 -05:00
intro_dynamic_inventory.rst Formatted Dynamic Inventory link for Openstack (#25351) 2017-06-15 03:00:00 -07:00
intro_getting_started.rst Some cleanup of the intro and getting started sections. (#25083) 2017-05-28 01:42:50 -07:00
intro_installation.rst Minor edit 2017-08-04 10:10:03 -07:00
intro_inventory.rst Added become_exe and become_flags docs (#19554) 2017-07-25 18:59:57 -07:00
intro_networking.rst Fix spelling mistakes (comments only) (#25564) 2017-06-12 07:55:19 +01:00
intro_patterns.rst Fix all RST errors for docs/docsite/rst (#20005) 2017-01-07 11:38:52 -08:00
intro_windows.rst update WSL installation docs for current builds (#25237) 2017-07-31 18:07:07 -07:00
modules.rst Doc module meta (#20093) 2017-01-10 12:58:22 -08:00
modules_intro.rst Fix all RST errors for docs/docsite/rst (#20005) 2017-01-07 11:38:52 -08:00
modules_support.rst Fix spelling mistakes (comments only) (#25564) 2017-06-12 07:55:19 +01:00
network_debug_troubleshooting.rst Persistent connection timer changes (#27272) 2017-08-01 11:45:45 -06:00
playbook_pahting.rst 2nd draft 2017-03-15 15:32:30 -04:00
playbooks.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_acceleration.rst consolidated docs 2017-01-06 09:16:59 -05:00
playbooks_advanced_syntax.rst Fix all RST errors for docs/docsite/rst (#20005) 2017-01-07 11:38:52 -08:00
playbooks_async.rst consolidated docs 2017-01-06 09:16:59 -05:00
playbooks_best_practices.rst Add module_utils example next to library examples (#25390) 2017-07-18 17:09:32 -07:00
playbooks_blocks.rst Docs porting guides 2.0 & 2.3 (#27632) 2017-08-02 21:36:17 +01:00
playbooks_checkmode.rst Minor edits. 2017-07-26 10:50:01 -04:00
playbooks_conditionals.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_debugger.rst Fix all RST errors for docs/docsite/rst (#20005) 2017-01-07 11:38:52 -08:00
playbooks_delegation.rst added note about not all tasks being 'delegatable' 2017-08-01 08:24:37 -04:00
playbooks_environment.rst Revert "made example not fail" 2017-04-10 12:17:19 -04:00
playbooks_error_handling.rst Add example task succeeding when RC is non-zero (#23698) 2017-04-18 14:17:52 +00:00
playbooks_filters.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_filters_ipaddr.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_intro.rst display v added 2017-06-23 16:44:48 -04:00
playbooks_lookups.rst Allow variables to be passed in to template lookup plugin (#18662) 2017-08-02 09:29:27 +05:30
playbooks_loops.rst filetree: Add documentation for lookup plugin (#26157) 2017-07-04 15:20:46 -07:00
playbooks_prompts.rst Update playbooks_prompts.rst (#22910) 2017-03-29 20:14:43 -07:00
playbooks_python_version.rst Update playbooks_python_version.rst 2017-04-25 12:26:40 -07:00
playbooks_reuse.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_reuse_includes.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_reuse_roles.rst Fix roles language in docs (#25811) 2017-06-26 23:10:07 -07:00
playbooks_roles.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_special_topics.rst moved docs generation and templates to docs/ 2017-03-24 15:52:36 -04:00
playbooks_startnstep.rst consolidated docs 2017-01-06 09:16:59 -05:00
playbooks_strategies.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_tags.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_templating.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_tests.rst Minor fix for typo - ismount to is_mount 2017-07-24 08:56:46 -04:00
playbooks_variables.rst Imports and includes (#25399) 2017-06-06 16:39:48 -05:00
playbooks_vault.rst Fix typo (#26988) 2017-07-19 08:33:04 -04:00
porting_guide_2.0.rst Docs porting guides 2.0 & 2.3 (#27632) 2017-08-02 21:36:17 +01:00
porting_guide_2.3.rst Docs porting guides 2.0 & 2.3 (#27632) 2017-08-02 21:36:17 +01:00
porting_guides.rst Docs porting guides 2.0 & 2.3 (#27632) 2017-08-02 21:36:17 +01:00
python_3_support.rst Fix reST markup (#23536) 2017-04-12 13:49:26 -04:00
quickstart.rst consolidated docs 2017-01-06 09:16:59 -05:00
release_and_maintenance.rst Improve release and development cycle documentation 2017-07-25 23:38:08 -07:00
test_strategies.rst consolidated docs 2017-01-06 09:16:59 -05:00
tower.rst Use HTTPS instead of legacy HTTP for ansible.com (#16870) 2017-02-15 16:09:33 -08:00
YAMLSyntax.rst Add some additional value quoting examples (#20464) 2017-03-05 01:27:54 -08:00