From eee18d2a0e375fd34778f8987a52258206bc1831 Mon Sep 17 00:00:00 2001 From: Hari Date: Thu, 11 Jan 2024 13:51:44 +0100 Subject: [PATCH] updated dependencies for sphinx --- .github/workflows/test-and-publish-release.yml | 5 ++--- .github/workflows/test-main.yml | 2 +- README.md | 2 +- docs/conf.py | 11 +++++++++-- setup.py | 2 -- 5 files changed, 13 insertions(+), 9 deletions(-) diff --git a/.github/workflows/test-and-publish-release.yml b/.github/workflows/test-and-publish-release.yml index cc429c0..22ccdf3 100644 --- a/.github/workflows/test-and-publish-release.yml +++ b/.github/workflows/test-and-publish-release.yml @@ -2,7 +2,7 @@ name: Build, test and publish Python 🐍 distributions 📦 to PyPI on: release: - types: [created] + types: [published] jobs: build-and-publish: @@ -45,8 +45,7 @@ jobs: - name: Build docs run: | - pip install sphinx==6.2.1 - pip install sphinx_rtd_theme recommonmark nbsphinx sphinx-autodoc-typehints sphinx-copybutton sphinx-prompt sphinx-notfound-page sphinx-version-warning sphinx-autodoc-annotation + pip install sphinx sphinx_rtd_theme recommonmark sphinx-autodoc-typehints sphinx-copybutton sphinx-prompt sphinx-notfound-page sphinx-autodoc-annotation sphinx-build -b html docs/ ./public - name: Deploy docs diff --git a/.github/workflows/test-main.yml b/.github/workflows/test-main.yml index 8e42e97..3474de4 100644 --- a/.github/workflows/test-main.yml +++ b/.github/workflows/test-main.yml @@ -7,7 +7,7 @@ on: pull_request: branches: - main - + jobs: test: name: Test diff --git a/README.md b/README.md index a37fcc6..4edcb1f 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ The normal process works like this: 1. You call `find_path` on one of your finder implementations. 1. `init_find` instantiates the `open_list` and resets all values and counters. 1. The main loop starts on the `open_list`. This list gets filled with all nodes that will be processed next (e.g. all current neighbors that are walkable). For this you need to implement `check_neighbors` in your own finder implementation. -1. For example in A*s implementation of `check_neighbors` you first want to get the next node closest from the current starting point from the open list. the `next_node` method in Finder does this by giving you the node with a minimum `f`-value from the open list, it closes it and removes it from the `open_list`. +1. For example in A\*s implementation of `check_neighbors` you first want to get the next node closest from the current starting point from the open list. the `next_node` method in Finder does this by giving you the node with a minimum `f`-value from the open list, it closes it and removes it from the `open_list`. 1. if this node is not the end node we go on and get its neighbors by calling `find_neighbors`. This just calls `grid.neighbors` for most algorithms. 1. If none of the neighbors are the end node we want to process the neighbors to calculate their distances in `process_node` 1. `process_node` calculates the cost `f` from the start to the current node using the `calc_cost` method and the cost after calculating `h` from `apply_heuristic`. diff --git a/docs/conf.py b/docs/conf.py index 1381abf..62fd362 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,9 +43,7 @@ "sphinx_copybutton", # for copy button "sphinx-prompt", # for prompt "notfound.extension", # for 404 page - "versionwarning.extension", # for version warning "recommonmark", # for markdown - "nbsphinx", # for notebooks ] templates_path = ["_templates"] @@ -55,6 +53,15 @@ ], } +notfound_context = { + "body": ( + "

Page not found.

\n\n" + "

Unfortunately, the page {{ pagename }} wasn't found.

\n\n" + "

Try going back to the homepage.

\n\n" + ), +} + +# source suffix source_suffix = [".rst", ".md"] # The master toctree document. diff --git a/setup.py b/setup.py index 6361530..8ecee78 100644 --- a/setup.py +++ b/setup.py @@ -33,12 +33,10 @@ "sphinx<=7.2.6", "sphinx_rtd_theme", "recommonmark", - "nbsphinx", "sphinx-autodoc-typehints", "sphinx-copybutton", "sphinx-prompt", "sphinx-notfound-page", - "sphinx-version-warning", "sphinx-autodoc-annotation", ] },