diff options
| author | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2023-01-01 19:44:35 +0000 |
|---|---|---|
| committer | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2023-01-01 19:44:35 +0000 |
| commit | f8e8584ea5f23580b9c3ab75f53a0aa743db64c6 (patch) | |
| tree | 783cfbf2645ed64053f195b699c388b4d765499f | |
| parent | a1c10f5d5e9734c6722d04b0b0781a5d88860745 (diff) | |
| download | sphinx-git-f8e8584ea5f23580b9c3ab75f53a0aa743db64c6.tar.gz | |
Update GitHub bug report template
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug-report.yml | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index fb0d7281e..218ad439c 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -23,7 +23,7 @@ body: ``index.rst`` file, and for ``sphinx.ext.autodoc`` bugs, this should ideally be a single ``index.rst`` file, and a single example Python module. - value: | + placeholder: | Minimal method (you can also paste the contents of ``index.rst`` and ``conf.py`` into this report): ```bash @@ -50,9 +50,10 @@ body: value: | ## Environment info - - type: input + - type: textarea attributes: label: Environment Information + render: text description: >- Install the latest Sphinx ``pip install -U "sphinx>=5.3"`` @@ -60,14 +61,15 @@ body: and paste the output here. validations: required: true - - type: input + - type: textarea attributes: label: Sphinx extensions + render: python description: >- Attempt to reproduce your error with the smallest set of extensions possible. This makes it easier to determine where the problem you are encountering is. - e.g. ["sphinx.ext.autodoc", "recommonmark"] + e.g. ``["sphinx.ext.autodoc", "recommonmark"]`` validations: required: false - type: textarea |