Connect with readthedocs

.readthedocs.yaml

@@ -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 OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+    install:
+        - requirements: docs/requirements.txt

README.md

@@ -0,0 +1,10 @@
+# KeplerOrbit
+
+Routines for working with near-Keplerian orbits. Convert between cartesian and Keplerian
+orbital elements, calculate libration widths, precession rates. Routines are vectorized
+so that you can easily work with large numbers of bodies.
+
+[![Build Status](https://github.com/spencerw/keplercalc/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/spencerw/keplercalc/actions)
+![Build Status](https://github.com/spencerw/keplercalc/actions/workflows/ci.yml/badge.svg)
+[![Documentation Status](https://readthedocs.org/projects/keplerorbit/badge/?version=latest)](https://keplerorbit.readthedocs.io/en/latest/?badge=latest)
+[![image](http://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/jobovy/exampy/blob/master/LICENSE)

docs/conf.py

@@ -36,5 +36,5 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 html_static_path = ['_static']