Skip to content

Commit

Permalink
Update GitHub bug report template
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Jan 1, 2023
1 parent a1c10f5 commit f8e8584
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -50,24 +50,26 @@ 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"``
then run ``sphinx-build --bug-report`` or ``python -m sphinx --bug-report``.
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
Expand Down

0 comments on commit f8e8584

Please sign in to comment.