Skip to content

Fix #1891: monkeypatch autodoc to avoid directive name conflict #1892

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

Merged
merged 2 commits into from
Sep 10, 2023

Conversation

pushfoo
Copy link
Member

@pushfoo pushfoo commented Sep 7, 2023

Changes

Fixes #1891 , unblocks #1890

  1. Monkeypatch instead of attempting to add a ClassDocumenter which conflicts with the autoclass directive
  2. Add doc explaining why / how this is necessary
  3. Add some whitespace

Follow up work

We should really consider making those "Is awesome Sphinx!" mugs.

How to test

Option 1: Locally

  1. ./make.py clean
  2. ./make.py html
  3. If the following warning no longer shows up, it's good:
    WARNING: while setting up extension conf.py: directive 'autoclass' is already registered, it will be overridden
    

Option 2: CI

  1. Rebase something which failed off this branch
  2. Push it to GitHub to trigger CI

* Add monkeypatch for ClassDocumenter to avoid name conflict warning

* Add doc explaining why
@pushfoo pushfoo changed the title Fix #1891: monkeypatching autodoc to avoid name conflict Fix #1891: monkeypatch autodoc to avoid directive name conflict Sep 7, 2023
@pvcraven pvcraven merged commit be9b001 into pythonarcade:development Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: Duplicated autoclass directive warning breaks doc build
2 participants