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

Fix #9436, #9471: autodoc: crashed if autodoc_class_signature = "separated" #9493

Merged
merged 1 commit into from Jul 25, 2021

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Jul 24, 2021

Feature or Bugfix

  • Bugfix

Purpose

…ss_signature = "separated"

A list should be used for special-members option instead of set.
@tk0miya tk0miya force-pushed the 9436_autodoc_class_signature branch from b8f0748 to 4f364a3 Compare July 24, 2021 05:52
@tk0miya tk0miya changed the base branch from 4.x to 4.1.x July 24, 2021 05:59
@tk0miya
Copy link
Member Author

tk0miya commented Jul 24, 2021

Note: I reproduced the error with this Dockerfile:

FROM python:3.9-slim

RUN apt update; apt install -y build-essential curl git unzip vim
RUN git clone https://github.com/miohtama/capitalgram-onchain-dex-quant-data
WORKDIR /capitalgram-onchain-dex-quant-data/docs/
RUN pip3 install Sphinx
RUN pip3 install sphinx_rtd_theme
RUN pip3 install nbsphinx
RUN pip3 install sphinx_sitemap
RUN apt install -y pandoc
RUN pip3 install ..
RUN echo '' >> source/conf.py
RUN echo 'autodoc_class_signature = "separated"' >> source/conf.py
RUN make html

@tk0miya tk0miya merged commit 5d8f925 into sphinx-doc:4.1.x Jul 25, 2021
@tk0miya tk0miya deleted the 9436_autodoc_class_signature branch July 25, 2021 10:09
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant