From 1f1640640e8b94c31cbd888029f8ba2021f79d72 Mon Sep 17 00:00:00 2001 From: Hari Date: Wed, 28 Feb 2024 11:38:19 +0100 Subject: [PATCH] Removed recommonmark infavor of myst-parser --- .github/workflows/publish-docs.yml | 2 +- .github/workflows/test-and-publish-release.yml | 2 +- CHANGELOG.md | 2 +- docs/_static/custom.css | 10 ++++++++++ docs/conf.py | 3 +-- docs/index.rst | 4 ++-- setup.py | 3 +-- 7 files changed, 17 insertions(+), 9 deletions(-) diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml index fa91e49..3ea1707 100644 --- a/.github/workflows/publish-docs.yml +++ b/.github/workflows/publish-docs.yml @@ -26,7 +26,7 @@ jobs: - name: Build docs run: | - pip install sphinx sphinx_rtd_theme recommonmark sphinx-autodoc-typehints sphinx-copybutton sphinx-prompt sphinx-notfound-page sphinx-autodoc-annotation + pip install sphinx sphinx_rtd_theme myst-parser sphinx-autodoc-typehints sphinx-copybutton sphinx-prompt sphinx-notfound-page sphinx-build -b html docs/ ./public cp -r docs/additional_resources/* ./public/ diff --git a/.github/workflows/test-and-publish-release.yml b/.github/workflows/test-and-publish-release.yml index 463c0e3..6e42768 100644 --- a/.github/workflows/test-and-publish-release.yml +++ b/.github/workflows/test-and-publish-release.yml @@ -46,7 +46,7 @@ jobs: - name: Build docs run: | - pip install sphinx sphinx_rtd_theme recommonmark sphinx-autodoc-typehints sphinx-copybutton sphinx-prompt sphinx-notfound-page sphinx-autodoc-annotation + pip install sphinx sphinx_rtd_theme myst-parser sphinx-autodoc-typehints sphinx-copybutton sphinx-prompt sphinx-notfound-page sphinx-build -b html docs/ ./public cp -r docs/additional_resources/* ./public/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 7ce6201..70063c2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# Changelog +# Version History ## 0.7.1 diff --git a/docs/_static/custom.css b/docs/_static/custom.css index a8734fb..9d05cfa 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -80,4 +80,14 @@ div[class^='highlight'] { border-radius: 5px; padding: 2px 4px; color: #333333; +} + +/* Tables */ +.wy-table-responsive table td, +.wy-table-responsive table th { + white-space: normal !important; +} + +.wy-table-responsive { + overflow: visible !important; } \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index b6ec305..8acd2f9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -39,11 +39,10 @@ "sphinx.ext.graphviz", # for graphviz "sphinx.ext.mathjax", # for math "sphinx_autodoc_typehints", # for type hints - "sphinx_autodoc_annotation", # for annotations "sphinx_copybutton", # for copy button "sphinx-prompt", # for prompt "notfound.extension", # for 404 page - "recommonmark", # for markdown + "myst_parser", # for markdown ] templates_path = ["_templates"] diff --git a/docs/index.rst b/docs/index.rst index 07e4e87..8bafd01 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to pathfinding3d's documentation! -========================================= +Welcome to documentation of pathfinding3d! +========================================== .. toctree:: :maxdepth: 3 diff --git a/setup.py b/setup.py index c3a6309..9dc7835 100644 --- a/setup.py +++ b/setup.py @@ -33,12 +33,11 @@ "coverage", "sphinx<=7.2.6", "sphinx_rtd_theme", - "recommonmark", + "myst-parser", "sphinx-autodoc-typehints", "sphinx-copybutton", "sphinx-prompt", "sphinx-notfound-page", - "sphinx-autodoc-annotation", ], "vis": ["plotly"], },