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

[WIP] Docs via build script helper #55986

Open
wants to merge 1 commit into
base: devel
from

Conversation

Projects
None yet
3 participants
@abadger
Copy link
Member

commented May 1, 2019

SUMMARY

This change is based on top of #55893

Move common build code from _build_helpers

We have some common code used by several docs scripts.  Migrate that
into the build-only shared code repository.

* Move lib/ansible/utils/_build_helpers.py to the directory for common
  build code
* Migrate docs/bin/dump_config.py to a build-ansible subcommand
* Migrate dump_keywords to the build-ansible framework
  * Make the script more maintainable by using functions and good
    variable names
  * Port to Python3 idioms
  * Fix bug so that private attributes will be undocumented
ISSUE TYPE
  • Bugfix Pull Request
  • Docs Pull Request

Note: Docs team can look at/try this once it gets to a later stage as it touches scripts that they use. It is mostly code, though.

COMPONENT NAME
  • docs/bin/dump_config.py
  • docs/bin/dump_keywords.py
  • docs/bin/generate_man.py
  • docs/bin/plugin_formatter.py
@ansibot

This comment has been minimized.

Copy link
Contributor

commented May 1, 2019

@abadger abadger force-pushed the abadger:docs-via-build-script-helper branch from 2a62397 to c7f6ee4 May 1, 2019

@ansibot ansibot removed the needs_rebase label May 1, 2019

@abadger abadger force-pushed the abadger:docs-via-build-script-helper branch from 1a0c059 to 0a2d272 May 2, 2019

@nitzmahone nitzmahone removed the needs_triage label May 2, 2019

@abadger abadger force-pushed the abadger:docs-via-build-script-helper branch from 0a2d272 to 8cf0db4 May 12, 2019

Move common build code from _build_helpers
We have some common code used by several docs scripts.  Migrate that
into the build-only shared code repository.

* Move lib/ansible/utils/_build_helpers.py to the directory for common
  build code
* Migrate docs/bin/dump_config.py to a build-ansible subcommand
* Migrate dump_keywords to the build-ansible framework
  * Make the script more maintainable by using functions and good
    variable names
  * Port to Python3 idioms
  * Fix bug so that private attributes will be undocumented
* Move generate_man to a build-ansible subcommand
* Port plugin_formatter to a build-ansible subcommand
* Rework command_plugins so that docs scripts can target Python-3.4+ and
  releng-only subcommands can use more recent versions of Python.
  The architecture is now that command_plugins/* need to be importable
  on Python-3.4.  The init_parsers() method needs to run on Python-3.4.
  But the main() method can utilize features of more recent Python as
  long as it fits within those parameters.

Port the plugin_formatter to build-ansible framework

@abadger abadger force-pushed the abadger:docs-via-build-script-helper branch from 8cf0db4 to 4c57046 May 12, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.