From 06a56b7beb9206677515c6988cd59ba4c1eb7bb4 Mon Sep 17 00:00:00 2001 From: Roman Yurchak Date: Fri, 12 Apr 2024 14:22:56 +0200 Subject: [PATCH] MAINT Fix documentation building (#80) --- CHANGELOG.md | 5 +++++ doc/changelog.md | 2 ++ doc/conf.py | 4 ++-- doc/index.md | 12 ++++++++++++ doc/index.rst | 14 -------------- doc/overview.rst | 1 - doc/requirements.in | 2 +- doc/requirements.txt | 27 ++++++++++++++++++--------- 8 files changed, 40 insertions(+), 27 deletions(-) create mode 100644 doc/changelog.md create mode 100644 doc/index.md delete mode 100644 doc/index.rst delete mode 100644 doc/overview.rst diff --git a/CHANGELOG.md b/CHANGELOG.md index b81a9b8..aa2662a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,9 @@ # Release notes +## Version 0.5.0 +*April 12, 2024* + + - Change to minimum supported Python version to 3.10. Run unit test with pandas 2.0. + [#74](https://github.com/symerio/pgeocode/pull/74) ## Version 0.4.1 diff --git a/doc/changelog.md b/doc/changelog.md new file mode 100644 index 0000000..66efc0f --- /dev/null +++ b/doc/changelog.md @@ -0,0 +1,2 @@ +```{include} ../CHANGELOG.md +``` diff --git a/doc/conf.py b/doc/conf.py index 26d596e..625dedc 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -43,7 +43,7 @@ "sphinx.ext.mathjax", "sphinx.ext.autodoc", "sphinx.ext.autosummary", - "sphinxcontrib.napoleon", + "sphinx.ext.napoleon", "sphinx.ext.linkcode", "myst_parser", ] @@ -83,7 +83,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 0000000..836aaf9 --- /dev/null +++ b/doc/index.md @@ -0,0 +1,12 @@ +```{include} ../README.md +``` + +```{eval-rst} +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + contributing + api + changelog +``` diff --git a/doc/index.rst b/doc/index.rst deleted file mode 100644 index e168d88..0000000 --- a/doc/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. pgeocode documentation master file, created by - sphinx-quickstart on Sun Feb 4 15:22:38 2018. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Pgeocode -======== -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - overview - contributing - api diff --git a/doc/overview.rst b/doc/overview.rst deleted file mode 100644 index 72a3355..0000000 --- a/doc/overview.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../README.rst diff --git a/doc/requirements.in b/doc/requirements.in index f54742a..172afa4 100644 --- a/doc/requirements.in +++ b/doc/requirements.in @@ -4,5 +4,5 @@ sphinx pillow recommonmark sphinx_rtd_theme -sphinxcontrib-napoleon +myst-parser ../ diff --git a/doc/requirements.txt b/doc/requirements.txt index 77ca7d8..169b81e 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -12,6 +12,7 @@ commonmark==0.9.1 # via recommonmark docutils==0.20.1 # via + # myst-parser # recommonmark # sphinx # sphinx-rtd-theme @@ -20,11 +21,22 @@ idna==3.7 imagesize==1.4.1 # via sphinx jinja2==3.1.3 - # via sphinx + # via + # myst-parser + # sphinx joblib==1.4.0 # via scikit-learn +markdown-it-py==3.0.0 + # via + # mdit-py-plugins + # myst-parser markupsafe==2.1.5 # via jinja2 +mdit-py-plugins==0.4.0 + # via myst-parser +mdurl==0.1.2 + # via markdown-it-py +myst-parser==2.0.0 numpy==1.26.4 # via # pandas @@ -35,16 +47,16 @@ packaging==24.0 # via sphinx pandas==2.2.2 # via pgeocode -pgeocode @ ../ +../ pillow==10.3.0 -pockets==0.9.1 - # via sphinxcontrib-napoleon pygments==2.17.2 # via sphinx python-dateutil==2.9.0.post0 # via pandas pytz==2024.1 # via pandas +pyyaml==6.0.1 + # via myst-parser recommonmark==0.7.1 requests==2.31.0 # via @@ -54,14 +66,12 @@ scikit-learn==1.4.2 scipy==1.13.0 # via scikit-learn six==1.16.0 - # via - # pockets - # python-dateutil - # sphinxcontrib-napoleon + # via python-dateutil snowballstemmer==2.2.0 # via sphinx sphinx==7.2.6 # via + # myst-parser # recommonmark # sphinx-rtd-theme # sphinxcontrib-jquery @@ -76,7 +86,6 @@ sphinxcontrib-jquery==4.1 # via sphinx-rtd-theme sphinxcontrib-jsmath==1.0.1 # via sphinx -sphinxcontrib-napoleon==0.7 sphinxcontrib-qthelp==1.0.7 # via sphinx sphinxcontrib-serializinghtml==1.1.10