mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Update GitHub bug report template
This commit is contained in:
10
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
10
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user