Skip to content

Commit f500518

Browse files
committed
Update docs
1 parent f319a14 commit f500518

File tree

10 files changed

+95
-4
lines changed

10 files changed

+95
-4
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Relevant Requirements**
14+
Indicate any enhancement issues (i.e., requirements) that are impacted by this issue.
15+
16+
**To Reproduce**
17+
Steps to reproduce the behavior:
18+
1. Go to '...'
19+
2. Click on '....'
20+
3. Scroll down to '....'
21+
4. See error
22+
23+
**Expected behavior**
24+
A clear and concise description of what you expected to happen.
25+
26+
**Screenshots**
27+
If applicable, add screenshots to help explain your problem.
28+
29+
**Desktop (please complete the following information):**
30+
- OS: [e.g. OSX]
31+
- Python Version [e.g. 3.7]
32+
33+
**Additional context**
34+
Add any other context about the problem here.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Documentation Update
3+
about: Update to documentation
4+
title: ''
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
** Location where change is recommended **
11+
12+
** Recommended change **
13+
14+
** Reason **
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Requirement Text**
11+
What must this feature do, specifically - this is the thing to test to. E.g., Ability to simulate model until a specified event has been met.
12+
13+
**Background Information**
14+
Optional
15+
16+
**Suggested Solution**
17+
Optional, Solution that is proposed. Requirement can be met with other solutions
18+
19+
**DoD**
20+
edit this to be a list of tasks that need to be completed
21+
- [ ] Implement feature
22+
- [ ] Add to example
23+
- [ ] Add to tutorial
24+
- [ ] Add tests
25+
- [ ] update documentation
26+
- [ ] Add to change notes for next release
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Testing Update
3+
about: Update to tests or CI/CD pipeline
4+
title: ''
5+
labels: CI/CD
6+
assignees: ''
7+
8+
---
9+
10+
** Test to Update **
11+
12+
** Change Recommended **
13+
14+
** Reason **

docs/.doctrees/dev_guide.doctree

222 Bytes
Binary file not shown.

docs/.doctrees/environment.pickle

-171 Bytes
Binary file not shown.

docs/_sources/dev_guide.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,8 @@ Post-Release Checklist
137137
* For prog_server: Update openapi specs on `SwaggerHub <https://app.swaggerhub.com/apis/teubert/prog_server/1.0.0-oas3>`__
138138
* Send notes to Software Release Office (SRO) of updated version number
139139
* Publish to PyPi
140-
* Send Highlight
140+
* Tag release with DOI
141+
* Send Highlights
141142

142143
Notes for Developers
143144
--------------------

docs/dev_guide.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,8 @@ <h2>Post-Release Checklist<a class="headerlink" href="#post-release-checklist" t
500500
<li><p>For prog_server: Update openapi specs on <a class="reference external" href="https://app.swaggerhub.com/apis/teubert/prog_server/1.0.0-oas3">SwaggerHub</a></p></li>
501501
<li><p>Send notes to Software Release Office (SRO) of updated version number</p></li>
502502
<li><p>Publish to PyPi</p></li>
503-
<li><p>Send Highlight</p></li>
503+
<li><p>Tag release with DOI</p></li>
504+
<li><p>Send Highlights</p></li>
504505
</ul>
505506
</section>
506507
<section id="notes-for-developers">

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sphinx-config/dev_guide.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,8 @@ Post-Release Checklist
137137
* For prog_server: Update openapi specs on `SwaggerHub <https://app.swaggerhub.com/apis/teubert/prog_server/1.0.0-oas3>`__
138138
* Send notes to Software Release Office (SRO) of updated version number
139139
* Publish to PyPi
140-
* Send Highlight
140+
* Tag release with DOI
141+
* Send Highlights
141142

142143
Notes for Developers
143144
--------------------

0 commit comments

Comments
 (0)