From a3a4437fea4968fb1863c1e2e142babd6b63150e Mon Sep 17 00:00:00 2001 From: Ray <7869818+rayrrr@users.noreply.github.com> Date: Thu, 8 Aug 2024 12:10:29 -0400 Subject: [PATCH] Readthedocs fix (#227) Given that this only affects already-broken documentation and passes all tests...YOLO --- .readthedocs.yaml | 18 ++++++++++++++++++ docs/index.rst | 1 - docs/source/conf.py | 29 +++++++++++++++++++++++++++++ docs/source/index.rst | 10 ++++++++++ docs/source/theme.toml | 3 +++ setup.py | 2 +- 6 files changed, 61 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 docs/index.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/theme.toml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..5f0616c --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,18 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.10" + +sphinx: + configuration: docs/source/conf.py + +python: + install: + - method: pip + path: . diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 72a3355..0000000 --- a/docs/index.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../README.rst diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..e30fd22 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,29 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'geojson' +copyright = '2024, Sean Gillies, Matthew Russell, Corey Farwell, Blake Grotewold, \ + Zsolt Ero, Sergey Romaov, Ray Riga' +author = 'Sean Gillies, Matthew Russell, Corey Farwell, Blake Grotewold, Zsolt Ero, \ + Sergey Romaov, Ray Riga' +release = '3.1.0' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ['sphinxcontrib.jquery'] + +templates_path = ['_templates'] +exclude_patterns = [] + +# -- 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_path = ['_theme'] +html_static_path = ['_static'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..ca8255a --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,10 @@ +.. geojson documentation master file, created by + sphinx-quickstart on Tue Aug 6 21:00:20 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +.. include:: ../../README.rst diff --git a/docs/source/theme.toml b/docs/source/theme.toml new file mode 100644 index 0000000..1869c89 --- /dev/null +++ b/docs/source/theme.toml @@ -0,0 +1,3 @@ +[theme] +name = "sphinx_rtd_theme" +base_url = "https://readthedocs.org/projects/sphinx-rtd-theme/" diff --git a/setup.py b/setup.py index f5b8380..95b2823 100644 --- a/setup.py +++ b/setup.py @@ -31,7 +31,7 @@ author="Sean Gillies", author_email="sgillies@frii.com", maintainer="Ray Riga", - maintainer_email="ray@strongoutput.com", + maintainer_email="ray.maintainer@gmail.com", url="https://github.com/jazzband/geojson", long_description=readme_text, packages=["geojson"],