mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
Add GitHub templates (#410)
* Add issue template * Move contributing docs into there own file * Delete CONTRIBUTING.md * Address Review - Style the code block with `rst` - Add python version
This commit is contained in:
parent
25fb424668
commit
54d62483bf
26
.github/ISSUE_TEMPLATE.md
vendored
Normal file
26
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
|
||||
### Problem
|
||||
|
||||
Give details on your issue.
|
||||
|
||||
### Reproducible Project
|
||||
|
||||
Please give a link to a public reproducible project or provide an example of the Restructured Text that gives an issue.
|
||||
|
||||
```rst
|
||||
Place RST code here (if any).
|
||||
```
|
||||
|
||||
#### Error Logs/Results
|
||||
|
||||
Place any images or error logs that might be able to help solve the issue here.
|
||||
|
||||
#### Expected Results
|
||||
|
||||
Please describe how this should work properly.
|
||||
|
||||
### Environment Info
|
||||
|
||||
- Python Version:
|
||||
- Sphinx Version:
|
||||
- RTD Theme Version:
|
11
README.rst
11
README.rst
@ -246,6 +246,7 @@ By default, the navigation will "stick" to the screen as you scroll. However if
|
||||
is vertically too large, it will revert to static positioning. To disable the sticky nav
|
||||
altogether change the setting in ``conf.py``.
|
||||
|
||||
|
||||
Contributing or modifying the theme
|
||||
===================================
|
||||
|
||||
@ -299,16 +300,6 @@ This default task will do the following **very cool things that make it worth th
|
||||
#. Rebuild the sphinx docs anytime it notices a change to ``.rst``, ``.html``, ``.js``
|
||||
or ``.css`` files.
|
||||
|
||||
Before you create an issue
|
||||
--------------------------
|
||||
|
||||
I don't have a lot of time to maintain this project due to other responsibilities.
|
||||
I know there are a lot of Python engineers out there that can't code sass / css and
|
||||
are unable to submit pull requests. That said, submitting random style bugs without
|
||||
at least providing sample documentation that replicates your problem is a good
|
||||
way for me to ignore your request. RST unfortunately can spit out a lot of things
|
||||
in a lot of ways. I don't have time to research your problem for you, but I do
|
||||
have time to fix the actual styling issue if you can replicate the problem for me.
|
||||
|
||||
Releasing the Theme
|
||||
===================
|
||||
|
Loading…
Reference in New Issue
Block a user