Skip to content

Commit

Permalink
Add readthedocs config. Add .github templates. (#11)
Browse files Browse the repository at this point in the history
* Add .readthedocs.yaml
* Add issue, enhancement and PR templates
  • Loading branch information
gallego-posada authored Mar 15, 2022
1 parent 8a8493a commit 8cce842
Show file tree
Hide file tree
Showing 7 changed files with 105 additions and 0 deletions.
File renamed without changes.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_template.md
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. -->
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
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
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement_template.md
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. -->
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
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. -->
32 changes: 32 additions & 0 deletions .readthedocs.yaml
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:
# - pdf

# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- docs
5 changes: 5 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ docs =
sphinxcontrib-katex>=0.8.6
sphinxcontrib-bibtex>=2.4.1
sphinx>=4.3.1
matplotlib>=3.5.0
ipykernel>=6.5.0
ipywidgets>=7.6.0
black[jupyter]>=21.12b0
torchvision>=0.11.2
tests =
black==21.12b0
flake8==4.0.1
Expand Down

0 comments on commit 8cce842

Please sign in to comment.