7
7
attributes :
8
8
label : Describe the bug
9
9
description : >-
10
- A clear and concise description of what the bug is.
10
+ A clear and concise description of what the bug is, including the
11
+ expected behaviour and what has gone wrong.
12
+
13
+ Please include screenshots, if applicable.
11
14
validations :
12
15
required : true
13
16
14
17
- type : textarea
15
18
attributes :
16
19
label : How to Reproduce
17
- description : Please provide steps to reproduce this bug.
20
+ description : >-
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
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
25
+ module.
18
26
value : |
27
+ Minimal method (you can also paste the contents of ``index.rst`` and
28
+ ``conf.py`` into this report):
29
+ ```bash
30
+ $ echo "Content demonstrating the bug..." > index.rst
31
+ $ echo "" > conf.py
32
+ $ sphinx-build -M html . _build
33
+ $ # open _build/html/index and see bla bla
19
34
```
35
+
36
+ ``git clone`` method (this is advised against, to help the Sphinx team):
37
+ ```bash
20
38
$ git clone https://github.com/.../some_project
21
39
$ cd some_project
22
40
$ pip install -r requirements.txt
@@ -27,67 +45,37 @@ body:
27
45
validations :
28
46
required : true
29
47
30
- - type : textarea
31
- attributes :
32
- label : Expected behavior
33
- description : >-
34
- A clear and concise description of what you expected to happen.
35
-
36
- - type : input
37
- attributes :
38
- label : Your project
39
- description : >-
40
- Link to your sphinx project, or attach zipped small project sample.
41
- validations :
42
- required : true
43
-
44
- - type : textarea
45
- attributes :
46
- label : Screenshots
47
- description : >-
48
- If applicable, add screenshots to help explain your problem.
49
- validations :
50
- required : false
51
-
52
48
- type : markdown
53
49
attributes :
54
50
value : |
55
51
## Environment info
56
52
57
53
- type : input
58
54
attributes :
59
- label : OS
55
+ label : Environment Information
60
56
description : >-
61
- [e.g. Unix/Linux/Mac/Win/other with version]
62
- validations :
63
- required : true
64
- - type : input
65
- attributes :
66
- label : Python version
67
- validations :
68
- required : true
69
- - type : input
70
- attributes :
71
- label : Sphinx version
57
+ Install development Sphinx
58
+ ``pip install https://github.com/AA-Turner/sphinx/archive/refs/heads/5.x.zip``
59
+ then run ``sphinx-build --bug-report`` or ``python -m sphinx --bug-report``.
60
+ and paste the output here.
72
61
validations :
73
62
required : true
74
63
- type : input
75
64
attributes :
76
65
label : Sphinx extensions
77
66
description : >-
78
- [e.g. sphinx.ext.autodoc, recommonmark]
79
- validations :
80
- required : false
81
- - type : input
82
- attributes :
83
- label : Extra tools
84
- description : >-
85
- [e.g. Browser, tex or something else]
67
+ Attempt to reproduce your error with the smallest set of extensions possible.
68
+ This makes it easier to determine where the problem you are encountering is.
69
+
70
+ e.g. ["sphinx.ext.autodoc", "recommonmark"]
86
71
validations :
87
72
required : false
88
73
- type : textarea
89
74
attributes :
90
75
label : Additional context
91
76
description : >-
92
- Add any other context about the problem here.
93
- [e.g. URL or Ticket]
77
+ Add any other context about the problem here, for example:
78
+
79
+ * Any other tools used (Browser, TeX, etc) with versions
80
+ * Reference to another issue or pull request
81
+ * URL to some external resource
0 commit comments