Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readthedocs fix #227

Merged
merged 7 commits into from
Aug 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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: .
1 change: 0 additions & 1 deletion docs/index.rst

This file was deleted.

29 changes: 29 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -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']
10 changes: 10 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions docs/source/theme.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[theme]
name = "sphinx_rtd_theme"
base_url = "https://readthedocs.org/projects/sphinx-rtd-theme/"
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
author="Sean Gillies",
author_email="[email protected]",
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"],
Expand Down
Loading