|
7 | 7 | attributes: |
8 | 8 | label: Describe the bug |
9 | 9 | description: >- |
10 | | - A clear and concise description of what the bug is, including the |
| 10 | + A clear and concise description of what the bug is, including the |
11 | 11 | expected behaviour and what has gone wrong. |
12 | | - |
| 12 | +
|
13 | 13 | Please include screenshots, if applicable. |
14 | 14 | validations: |
15 | 15 | required: true |
|
19 | 19 | label: How to Reproduce |
20 | 20 | description: >- |
21 | 21 | Please provide steps to reproduce this bug, with the smallest possible |
22 | | - set of source files. For normal bugs this should ideally be one |
| 22 | + set of source files. For normal bugs this should ideally be one |
23 | 23 | ``index.rst`` file, and for ``sphinx.ext.autodoc`` bugs, this should |
24 | | - ideally be a single ``index.rst`` file, and a single example Python |
| 24 | + ideally be a single ``index.rst`` file, and a single example Python |
25 | 25 | module. |
26 | 26 | placeholder: | |
27 | 27 | Minimal method (you can also paste the contents of ``index.rst`` and |
|
32 | 32 | $ sphinx-build -M html . _build |
33 | 33 | $ # open _build/html/index and see bla bla |
34 | 34 | ``` |
35 | | - |
| 35 | +
|
36 | 36 | ``git clone`` method (this is advised against, to help the Sphinx team): |
37 | 37 | ```bash |
38 | 38 | $ git clone https://github.com/.../some_project |
|
55 | 55 | label: Environment Information |
56 | 56 | render: text |
57 | 57 | description: >- |
58 | | - Install the latest Sphinx |
| 58 | + Install the latest Sphinx |
59 | 59 | ``pip install -U "sphinx>=5.3"`` |
60 | 60 | then run ``sphinx-build --bug-report`` or ``python -m sphinx --bug-report``. |
61 | 61 | and paste the output here. |
|
68 | 68 | description: >- |
69 | 69 | Attempt to reproduce your error with the smallest set of extensions possible. |
70 | 70 | This makes it easier to determine where the problem you are encountering is. |
71 | | - |
| 71 | +
|
72 | 72 | e.g. ``["sphinx.ext.autodoc", "recommonmark"]`` |
73 | 73 | validations: |
74 | 74 | required: false |
|
77 | 77 | label: Additional context |
78 | 78 | description: >- |
79 | 79 | Add any other context about the problem here, for example: |
80 | | - |
| 80 | +
|
81 | 81 | * Any other tools used (Browser, TeX, etc) with versions |
82 | 82 | * Reference to another issue or pull request |
83 | 83 | * URL to some external resource |
0 commit comments