Skip to content

MAINT: Refactoring get_doc_object #452

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 3 commits into from
Mar 14, 2023
Merged

Conversation

koyuki7w
Copy link
Contributor

@koyuki7w koyuki7w commented Mar 2, 2023

Removed some duplicated code according to the comment in the original code:

# TODO: refactor to use docscrape.get_doc_object
def get_doc_object(obj, what=None, doc=None, config=None, builder=None):

@larsoner
Copy link
Collaborator

larsoner commented Mar 3, 2023

Pushed an empty commit to make CircleCI willing to run the doc build

@larsoner
Copy link
Collaborator

larsoner commented Mar 3, 2023

Failures appear to be due to a new pydata-sphinx-theme version, I'll try to fix them in #453

@jarrodmillman jarrodmillman added this to the 1.6.0 milestone Mar 14, 2023
@larsoner larsoner merged commit 3d4a583 into numpy:main Mar 14, 2023
@larsoner
Copy link
Collaborator

Thanks @F3eQnxN3RriK !

@koyuki7w koyuki7w deleted the refactor-docscrape branch March 19, 2023 02:22
guillaumedavidphd added a commit to guillaumedavidphd/numpydoc that referenced this pull request Apr 7, 2023
* MAINT: Fix CIs for sphinx 6 (numpy#448)

* BUG: PR06 logic to only fail when type is used standalone (numpy#447)

Change PR06 logic to only fail when type is used standalone.

This prevents failures for user-defined classes, e.g. Mystring

Co-authored-by: Ross Barnowski <[email protected]>

* Update pre-commit (numpy#449)

* Update pre-commit

* Run pre-commit on all files

* Update blacken-docs repo in pre-commit conf after owner transfer. (numpy#451)

* MAINT: Compatibility with pydata-sphinx-theme (numpy#453)

Fix compatibility issues between latest pydata-sphinx-theme and sphinx 6.

Increase granularity of CI to test across necessary sphinx & Python version combos.

* MAINT: Refactoring `get_doc_object` (numpy#452)

---------

Co-authored-by: Eric Larson <[email protected]>
Co-authored-by: Bryce Mecum <[email protected]>
Co-authored-by: Ross Barnowski <[email protected]>
Co-authored-by: Jarrod Millman <[email protected]>
Co-authored-by: Stefanie Molin <[email protected]>
Co-authored-by: yuki <[email protected]>
guillaumedavidphd added a commit to guillaumedavidphd/numpydoc that referenced this pull request Apr 18, 2023
* MAINT: Fix CIs for sphinx 6 (numpy#448)

* BUG: PR06 logic to only fail when type is used standalone (numpy#447)

Change PR06 logic to only fail when type is used standalone.

This prevents failures for user-defined classes, e.g. Mystring

Co-authored-by: Ross Barnowski <[email protected]>

* Update pre-commit (numpy#449)

* Update pre-commit

* Run pre-commit on all files

* Update blacken-docs repo in pre-commit conf after owner transfer. (numpy#451)

* MAINT: Compatibility with pydata-sphinx-theme (numpy#453)

Fix compatibility issues between latest pydata-sphinx-theme and sphinx 6.

Increase granularity of CI to test across necessary sphinx & Python version combos.

* MAINT: Refactoring `get_doc_object` (numpy#452)

---------

Co-authored-by: Eric Larson <[email protected]>
Co-authored-by: Bryce Mecum <[email protected]>
Co-authored-by: Ross Barnowski <[email protected]>
Co-authored-by: Jarrod Millman <[email protected]>
Co-authored-by: Stefanie Molin <[email protected]>
Co-authored-by: yuki <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants