From 1690932b76f1c932207a1922a09ae4ae8fe5273b Mon Sep 17 00:00:00 2001 From: voetberg Date: Mon, 2 Oct 2023 11:40:02 -0500 Subject: [PATCH] readthedocs yaml added with poetry setup job --- .readthedocs.yaml | 17 +++++++++++++++++ CONTRIBUTING.md | 24 ------------------------ 2 files changed, 17 insertions(+), 24 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 CONTRIBUTING.md diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..8d2aa0b --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,17 @@ +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: "ubuntu-22.04" + tools: + python: "3.10" + jobs: + post_create_environment: + - pip install poetry + - poetry config virtualenvs.create false + post_install: + - poetry install + +sphinx: + configuration: docs/conf.py \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 2089543..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,24 +0,0 @@ -# How to contribute - -I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition. - -## Testing - -## Submitting changes - -Please send a [GitHub Pull Request SimplePhysicalImage](https://github.com/deepskies/SimplePhysicalImage/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). When you send a pull request, we will love you forever if you include examples. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit). - -Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this: - - $ git commit -m "A brief summary of the commit - > - > A paragraph describing what changed and its impact." - -## Coding conventions - -Start reading our code and you'll get the hang of it. We optimize for readability: - - * We indent using tabs - * We ALWAYS put spaces after list items and method parameters (`[1, 2, 3]`, not `[1,2,3]`), around operators (`x += 1`, not `x+=1`), and around hash arrows. - * This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible. -