Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs scripts cleanup #59169

Merged
merged 2 commits into from
Jul 17, 2019
Merged

Docs scripts cleanup #59169

merged 2 commits into from
Jul 17, 2019

Conversation

abadger
Copy link
Contributor

@abadger abadger commented Jul 17, 2019

SUMMARY

As discussed in this thread: #55986 (comment) the build subcommands for documentation should make the definition files mandatory. Since they're mandatory, the files should be positional arguments instead of option arguments.

ISSUE TYPE
  • Bugfix Pull Request
  • Docs Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

@webknjaz @acozine

@abadger
Copy link
Contributor Author

abadger commented Jul 17, 2019

This PR can be squashed on merge. I just made two commits to separate the two logical changes.

@ansibot
Copy link
Contributor

ansibot commented Jul 17, 2019

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python3.6 /root/ansible/test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make singlehtmldocs' failed with status code: 2
--> Standard Output
PYTHONPATH=../../lib ../../hacking/build-ansible.py document-config --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/ ../../lib/ansible/config/base.yml
Makefile:90: recipe for target 'config' failed
--> Standard Error
Traceback (most recent call last):
  File "../../hacking/build-ansible.py", line 88, in <module>
    main()
  File "../../hacking/build-ansible.py", line 79, in main
    retval = command.main(args)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/dump_config.py", line 63, in main
    with open(args.config_defs) as f:
TypeError: expected str, bytes or os.PathLike object, not list
make: *** [config] Error 1

click here for bot help

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 bug This issue/PR relates to a bug. docs This issue/PR relates to or includes documentation. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Jul 17, 2019
@webknjaz webknjaz self-requested a review July 17, 2019 17:34
@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Jul 17, 2019
Since the definition files are mandatory, make them positional
parameters instead of options.
@abadger abadger merged commit 5392d86 into ansible:devel Jul 17, 2019
@abadger abadger deleted the docs-scripts-cleanup branch July 17, 2019 19:01
@ansible ansible locked and limited conversation to collaborators Aug 15, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.9 This issue/PR affects Ansible v2.9 bug This issue/PR relates to a bug. docs This issue/PR relates to or includes documentation. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants