PR to patch 2.9/2.10 to work with sphinx 4 -
https://github.com/ansible/ansible/pull/75288(samccann,
15:08:56)
required_if does not need more info(samccann,
15:11:42)
required_if does not need descriptive test. We
can construct a standard documentation sentence from what we have to
give the argspec(samccann,
15:12:42)
roles documentation from the argspec pr -
https://github.com/ansible-community/antsibull/pull/272(samccann,
15:14:57)
on
https://github.com/ansible/ansible/pull/75288 - dmsimar talking with
fedora to see what the status is(samccann,
15:18:11)
ACTION: samccann and
acozine - review roles docs PR one last time -
https://github.com/ansible-community/antsibull/pull/272 to
approve(samccann,
15:19:41)
mutually_exclusive added to docs string(samccann, 15:20:52)
if we include this item, it needs a sanity
check to make sure if the info is in the DOCUMENTATION, it matches
the info in the argspec as well(samccann,
15:24:07)
- today's problem - a collection contributor
has no way to verify any docs changes work until after merging and
AFTER uploading to galaxy.(samccann,
15:29:41)
and waiting until devel docs pull in that
update to docs.ansible.com/ansible/devel. And that only works for
collections already in Ansible.(samccann,
15:30:31)
the solution should allow for these
contributors to generate the html, have :refs: that work, and not
require deep sphinx/rst knowledge(samccann,
15:31:16)
we could extend `antsibull-docs to create a
functioning docsite (document a collection and links work to ansible
docsite).(samccann,
15:38:24)
we'd need to document how to set up and invoke
this locally(samccann,
15:38:45)
https://gist.github.com/felixfontein/6de36fff529a12b0c4ffd4aa73a82b6d
(when run in an empty directory) will build a small docsite for
community.docker and community.crypto(samccann,
15:40:35)
maybe two commands: antsibull-docs init and
then the antsibull-docs collection command you already have(samccann,
15:43:25)
the proposed `antsibull init` command could
create an example script that runs out of the box or the user can
modify as they want.(samccann,
15:49:27)
antsibull-build should not get too involved in
knowing things that other tools should do (sphinx-build options,
setting up rsync, etc). But it's okay if those are in the script
with sane defaults and the user can tweak them to meet their
needs(samccann,
15:51:29)
ACTION: felixfontein
to work on creating the script associated with `antsibull` to allow
locally generated docsite for collection-level docs(samccann,
15:52:13)
validate-modules PR
https://github.com/ansible/ansible/pull/74873 can also impact all
the other users of DOCUMENTATION block, including galaxy-ng
etc(samccann,
16:00:27)