-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add readthedocs config. Add .github templates. (#11)
* Add .readthedocs.yaml * Add issue, enhancement and PR templates
- Loading branch information
1 parent
8a8493a
commit 8cce842
Showing
7 changed files
with
105 additions
and
0 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
about: "report a bug on Cooper" | ||
assignees: "" | ||
labels: "bug" | ||
name: "Bug" | ||
title: "" | ||
--- | ||
|
||
## Bug | ||
|
||
<!-- A brief description of the bug. --> | ||
|
||
## Steps | ||
|
||
<!-- The steps needed to reproduce the bug. --> | ||
|
||
## Expected behavior | ||
|
||
<!-- A brief description of the expected behavior. --> | ||
|
||
## Environment | ||
|
||
<!-- A brief description of the environment. --> | ||
|
||
## Context | ||
|
||
<!-- Code snippets, error messages, stack traces, etc. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- about: Ask and answer questions about Cooper | ||
name: Cooper Issues | ||
url: https://github.com/cooper-org/cooper/issues |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
about: "propose a Cooper enhancement" | ||
assignees: "" | ||
labels: "enhancement" | ||
name: "Enhancement" | ||
title: "" | ||
--- | ||
|
||
## Enhancement | ||
|
||
<!-- A brief description of the proposed enhancement. --> | ||
|
||
## Motivation | ||
|
||
<!-- The motivation for the proposed enhancement. --> | ||
|
||
## Alternatives | ||
|
||
<!-- A summary of possible alternatives to the proposed enhancement. --> | ||
|
||
## References | ||
|
||
<!-- A summary of scholarly references about the proposed enhancement. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
Closes #<!-- The issue that corresponds to the changes. --> | ||
|
||
## Changes | ||
|
||
<!-- A brief description of the changes. --> | ||
|
||
## Testing | ||
|
||
<!-- A brief description of the testing performed for the changes. --> | ||
|
||
## References | ||
|
||
<!-- A summary of source code references used to make the changes. --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the version of Python and other tools you might need | ||
build: | ||
os: ubuntu-20.04 | ||
tools: | ||
python: "3.8" | ||
# You can also specify other tool versions: | ||
# nodejs: "16" | ||
# rust: "1.55" | ||
# golang: "1.17" | ||
|
||
# Build documentation in the docs/ directory with Sphinx | ||
sphinx: | ||
configuration: docs/source/conf.py | ||
|
||
# If using Sphinx, optionally build your docs in additional formats such as PDF | ||
# formats: | ||
|
||
# Optionally declare the Python requirements required to build your docs | ||
python: | ||
install: | ||
- method: pip | ||
path: . | ||
extra_requirements: | ||
- docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters