[issue37390] Generate table of audit events for docs

Steve Dower added the comment: All seems to be fine now. -- resolution: -> fixed stage: needs patch -> resolved status: open -> closed ___ Python tracker ___

[issue37390] Generate table of audit events for docs

Steve Dower added the comment: Anyone from the docs team have any ideas here? We're going to present on this at EuroPython tomorrow and it'd be great to be able to point people at the docs. -- ___ Python tracker

[issue37390] Generate table of audit events for docs

Steve Dower added the comment: I can't repro this. It looks like Doc/makefile#L196 passes -Ea which ought to deal with any old files (and it certainly does on my Ubuntu machine), so it's likely not that. The table contents is simply not in the file on docs.p.o, so I guess there's something

[issue37390] Generate table of audit events for docs

Karthikeyan Singaravelan added the comment: Strange, I bet that I have seen this rendered table while the issue was closed. The docs table renders fine locally on latest master. Given that Audit event, Arguments and References table header are rendered with the table being replaced I guess s

[issue37390] Generate table of audit events for docs

Steve Dower added the comment: The page is not generating correctly at https://docs.python.org/dev/library/audit_events.html Adding the documentation team, where hopefully someone will know what needs poking. -- nosy: +eric.araujo, ezio.melotti, mdk, willingc resolution: fixed -> s

[issue37390] Generate table of audit events for docs

Karthikeyan Singaravelan added the comment: Thanks Steve, the page will serve as a good reference to all audit events. -- ___ Python tracker ___ __

[issue37390] Generate table of audit events for docs

Change by Steve Dower : -- resolution: -> fixed stage: patch review -> resolved status: open -> closed ___ Python tracker ___ ___ P

[issue37390] Generate table of audit events for docs

miss-islington added the comment: New changeset 4fee28aa42dbac7f08a6d2829546b7d8e848034d by Miss Islington (bot) in branch '3.8': bpo-37390: Add audit event table to documentations (GH-14406) https://github.com/python/cpython/commit/4fee28aa42dbac7f08a6d2829546b7d8e848034d -- nosy:

[issue37390] Generate table of audit events for docs

Steve Dower added the comment: New changeset 44f91c388a6f4da9ed3300df32ca290b8aa104ea by Steve Dower in branch 'master': bpo-37390: Add audit event table to documentations (GH-14406) https://github.com/python/cpython/commit/44f91c388a6f4da9ed3300df32ca290b8aa104ea -- __

[issue37390] Generate table of audit events for docs

Change by miss-islington : -- pull_requests: +14245 pull_request: https://github.com/python/cpython/pull/14429 ___ Python tracker ___ __

[issue37390] Generate table of audit events for docs

Steve Dower added the comment: I think my PR is ready. I had to go through and update all the audit-event tags that existed, since the argument parsing in Sphinx didn't work the way I first thought it did, but now we can provide a back reference manually (or let it auto-generate one to the l

[issue37390] Generate table of audit events for docs

Change by Steve Dower : -- keywords: +patch pull_requests: +14218 stage: needs patch -> patch review pull_request: https://github.com/python/cpython/pull/14406 ___ Python tracker _

[issue37390] Generate table of audit events for docs

Steve Dower added the comment: I took your code and made some improvements: https://github.com/python/cpython/compare/master...zooba:bpo37390 In particular, I added the backlinks from the table (but unfortunately they all go to the line of text we generate for the ..audit-event directive, an

[issue37390] Generate table of audit events for docs

Karthikeyan Singaravelan added the comment: I think my approach suffers from the drawback where duplicate items cannot be separated correctly as you have mentioned. Example as below where socket.connect and socket.connect_ex emit same event and I am not able to retrieve the function at which

[issue37390] Generate table of audit events for docs

Steve Dower added the comment: Awesome! I was just making a start on this too, and it looks like we were doing nearly identical work. Happy to let you keep going on it! Some things that I thought would be worth doing: * combine equivalent events (warn if names match but arguments are differen

[issue37390] Generate table of audit events for docs

Karthikeyan Singaravelan added the comment: I just tried an initial attempt at this and a screenshot as attached. I followed the approach similar to the one at https://www.sphinx-doc.org/en/master/development/tutorials/todo.html to gather all todos. The approach was to append all the audit e

[issue37390] Generate table of audit events for docs

Change by Karthikeyan Singaravelan : -- nosy: +xtreak ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe: https:/

[issue37390] Generate table of audit events for docs

New submission from Steve Dower : All audit events are marked in the docs with the ".. audit-event:: " syntax. We should automatically collate these into a single table and generate a new doc page as part of docs build. -- assignee: docs@python components: Documentation messages: 34