Merge 6c5feda into 1af43fd

.readthedocs.yml

@@ -13,7 +13,7 @@ build:
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
-  fail_on_warning: true
+  fail_on_warning: false
 
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:

docs/Makefile

@@ -30,7 +30,7 @@ help:
 clean:
 	-rm -rf $(BUILDDIR)/* build/plot_directive/*
 
-html: apidocs
+html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@@ -50,7 +50,7 @@ json:
 	@echo
 	@echo "Build finished; now you can process the JSON files."
 
-htmlhelp: apidocs
+htmlhelp:
 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 	@echo
 	@echo "Build finished; now you can run HTML Help Workshop with the" \
@@ -87,9 +87,3 @@ doctest:
 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 	@echo "Testing of doctests in the sources finished, look at the " \
 	      "results in $(BUILDDIR)/doctest/output.txt."
-
-apidocs:
-	sphinx-apidoc -f -s txt -o . ../shapely
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-

docs/changelog.rst

@@ -1 +1 @@
-.. include:: ../CHANGELOG.rst
+.. include:: ../CHANGES.txt

docs/conf.py

@@ -64,9 +64,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = shapely.__version__
+version = shapely.__version__.split("+")[0]
 # The full version, including alpha/beta/rc tags.
-release = shapely.__version__
+release = shapely.__version__.split("+")[0]
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -111,7 +111,7 @@
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "sphinx_book_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/environment.yml

@@ -6,5 +6,6 @@ dependencies:
   - geos=3.10
   - numpy
   - cython
+  - sphinx-book-theme
   - numpydoc==1.1.*
   - matplotlib

docs/index.rst

@@ -1,27 +1,24 @@
-=======
-Shapely
-=======
+.. include:: ../README.rst
+
+.. include:: ../CREDITS.txt
+
+.. include:: ../FAQ.rst
 
-Documentation Contents
-======================
 
 .. toctree::
-   :maxdepth: 2
+   :caption: User Guide
+   :hidden:
 
-   The Project <project>
+   installation
    User Manual <manual>
-   API Documentation <modules>
    migration
+   changelog
 
 
-API Reference
-=============
-
 .. toctree::
-   :maxdepth: 1
-   :caption: Contents:
+   :caption: API Reference
+   :hidden:
 
-   installation
    geometry
    creation
    io
@@ -33,7 +30,6 @@ API Reference
    coordinates
    strtree
    testing
-   changelog
 
 Indices and tables
 ==================