From eef31e4abddab8631807dc09fde7dc8aa5327ed7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Arne=20K=C3=BCderle?= Date: Tue, 13 Dec 2022 13:01:47 +0100 Subject: [PATCH] Fixed docu and final other renames --- docs/conf.py | 9 ++++---- docs/index.rst | 6 ++--- docs/modules/index.rst | 2 +- poetry.lock | 50 ++++++++++++++++++++++-------------------- pyproject.toml | 15 ++++++++----- 5 files changed, 44 insertions(+), 38 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index f7876b0..6fabf85 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -128,10 +128,11 @@ # intersphinx configuration intersphinx_module_mapping = { "numpy": ("https://numpy.org/doc/stable/", None), - "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None), - "matplotlib": ("https://matplotlib.org/", None), + "scipy": ("https://docs.scipy.org/doc/scipy/", None), + "matplotlib": ("https://matplotlib.org/stable/", None), "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None), "sklearn": ("https://scikit-learn.org/stable/", None), + "tpcp": ("https://tpcp.readthedocs.io/en/latest", None), } user_agent = "Mozilla/5.0 (X11; Linux x86_64; rv:25.0) Gecko/20100101 Firefox/25.0" @@ -145,7 +146,7 @@ sphinx_gallery_conf = { "examples_dirs": ["../examples"], "gallery_dirs": ["./auto_examples"], - "reference_url": {"gaitmap_datasets": None, **{k: v[0] for k, v in intersphinx_module_mapping.items()}}, + "reference_url": {"gaitmap_datasets": None}, # 'default_thumb_file': 'fig/logo.png', "backreferences_dir": "modules/generated/backreferences", "doc_module": ("gaitmap_datasets",), @@ -159,6 +160,6 @@ linkcode_resolve = make_linkcode_resolve( "gaitmap_datasets", - "https://github.com/mad-lab-fau/mad-datasets/blob/{revision}/{package}/{path}#L{lineno}", + "https://github.com/mad-lab-fau/gaitmap-datasets/blob/{revision}/{package}/{path}#L{lineno}", ) diff --git a/docs/index.rst b/docs/index.rst index 9e524ce..dc54afb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ -.. mad-datasets documentation master file +.. gaitmap-datasets documentation master file -mad-datasets Docu Overview -========================== +gaitmap-datasets Docu Overview +============================== .. toctree:: :maxdepth: 1 diff --git a/docs/modules/index.rst b/docs/modules/index.rst index 334d252..7744789 100644 --- a/docs/modules/index.rst +++ b/docs/modules/index.rst @@ -4,7 +4,7 @@ API Reference ============= -When working with mad-datasets, you should interact with the highlevel Dataset classes listed below. +When working with gaitmap-datasets, you should interact with the highlevel Dataset classes listed below. To better understand which class belongs to which dataset and how to use the respective classes, checkout the README (Getting Started) and the Examples. diff --git a/poetry.lock b/poetry.lock index b6a6799..d1c347b 100644 --- a/poetry.lock +++ b/poetry.lock @@ -980,7 +980,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "pydata-sphinx-theme" -version = "0.9.0" +version = "0.12.0" description = "Bootstrap-based Sphinx theme from the PyData community" category = "dev" optional = false @@ -990,12 +990,13 @@ python-versions = ">=3.7" beautifulsoup4 = "*" docutils = "!=0.17.0" packaging = "*" -sphinx = ">=4.0.2" +pygments = ">=2.7" +sphinx = ">=4.2" [package.extras] -coverage = ["codecov", "pydata-sphinx-theme[test]", "pytest-cov"] +coverage = ["codecov", "colorama", "pydata-sphinx-theme[test]", "pytest-cov"] dev = ["nox", "pre-commit", "pydata-sphinx-theme[coverage]", "pyyaml"] -doc = ["jupyter_sphinx", "myst-parser", "numpy", "numpydoc", "pandas", "plotly", "pytest", "pytest-regressions", "sphinx-design", "sphinx-sitemap", "sphinxext-rediraffe", "xarray"] +doc = ["ablog", "jupyter_sphinx", "linkify-it-py", "matplotlib", "myst-nb", "nbsphinx", "numpy", "numpydoc", "pandas", "plotly", "pytest", "pytest-regressions", "rich", "sphinx-copybutton", "sphinx-design", "sphinx-sitemap", "sphinx-togglebutton", "sphinxext-rediraffe", "xarray"] test = ["pydata-sphinx-theme[doc]", "pytest"] [[package]] @@ -1355,7 +1356,7 @@ python-versions = ">=3.6" [[package]] name = "Sphinx" -version = "4.5.0" +version = "5.3.0" description = "Python documentation generator" category = "dev" optional = false @@ -1363,16 +1364,16 @@ python-versions = ">=3.6" [package.dependencies] alabaster = ">=0.7,<0.8" -babel = ">=1.3" -colorama = {version = ">=0.3.5", markers = "sys_platform == \"win32\""} -docutils = ">=0.14,<0.18" -imagesize = "*" -importlib-metadata = {version = ">=4.4", markers = "python_version < \"3.10\""} -Jinja2 = ">=2.3" -packaging = "*" -Pygments = ">=2.0" +babel = ">=2.9" +colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""} +docutils = ">=0.14,<0.20" +imagesize = ">=1.3" +importlib-metadata = {version = ">=4.8", markers = "python_version < \"3.10\""} +Jinja2 = ">=3.0" +packaging = ">=21.0" +Pygments = ">=2.12" requests = ">=2.5.0" -snowballstemmer = ">=1.1" +snowballstemmer = ">=2.0" sphinxcontrib-applehelp = "*" sphinxcontrib-devhelp = "*" sphinxcontrib-htmlhelp = ">=2.0.0" @@ -1382,19 +1383,19 @@ sphinxcontrib-serializinghtml = ">=1.1.5" [package.extras] docs = ["sphinxcontrib-websupport"] -lint = ["docutils-stubs", "flake8 (>=3.5.0)", "isort", "mypy (>=0.931)", "types-requests", "types-typed-ast"] -test = ["cython", "html5lib", "pytest", "pytest-cov", "typed-ast"] +lint = ["docutils-stubs", "flake8 (>=3.5.0)", "flake8-bugbear", "flake8-comprehensions", "flake8-simplify", "isort", "mypy (>=0.981)", "sphinx-lint", "types-requests", "types-typed-ast"] +test = ["cython", "html5lib", "pytest (>=4.6)", "typed_ast"] [[package]] name = "sphinx-gallery" -version = "0.10.1" +version = "0.11.1" description = "A Sphinx extension that builds an HTML version of any Python script and puts it into an examples gallery." category = "dev" optional = false python-versions = ">=3.7" [package.dependencies] -sphinx = ">=1.8.3" +sphinx = ">=3" [[package]] name = "sphinxcontrib-applehelp" @@ -1627,7 +1628,7 @@ testing = ["flake8 (<5)", "func-timeout", "jaraco.functools", "jaraco.itertools" [metadata] lock-version = "1.1" python-versions = ">=3.8,<4.0" -content-hash = "8ce26bc01a10bbabbea1811fb10daceec8170827e01ce32152cb8522860eaf6d" +content-hash = "964f36e58f55f9ec2c561be7efa4428f30b4426f6ab59f99d582c9a4da34f566" [metadata.files] alabaster = [ @@ -2435,8 +2436,8 @@ pycparser = [ {file = "pycparser-2.21.tar.gz", hash = "sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206"}, ] pydata-sphinx-theme = [ - {file = "pydata_sphinx_theme-0.9.0-py3-none-any.whl", hash = "sha256:b22b442a6d6437e5eaf0a1f057169ffcb31eaa9f10be7d5481a125e735c71c12"}, - {file = "pydata_sphinx_theme-0.9.0.tar.gz", hash = "sha256:03598a86915b596f4bf80bef79a4d33276a83e670bf360def699dbb9f99dc57a"}, + {file = "pydata_sphinx_theme-0.12.0-py3-none-any.whl", hash = "sha256:c17dbab67a3774f06f34f6378e896fcd0668cc8b5da1c1ba017e65cf1df0af58"}, + {file = "pydata_sphinx_theme-0.12.0.tar.gz", hash = "sha256:7a07c3ac1fb1cfbb5f7d1e147a9500fb120e329d610e0fa2caac4a645141bdd9"}, ] pydocstyle = [ {file = "pydocstyle-6.1.1-py3-none-any.whl", hash = "sha256:6987826d6775056839940041beef5c08cc7e3d71d63149b48e36727f70144dc4"}, @@ -2702,11 +2703,12 @@ soupsieve = [ {file = "soupsieve-2.3.2.post1.tar.gz", hash = "sha256:fc53893b3da2c33de295667a0e19f078c14bf86544af307354de5fcf12a3f30d"}, ] Sphinx = [ - {file = "Sphinx-4.5.0-py3-none-any.whl", hash = "sha256:ebf612653238bcc8f4359627a9b7ce44ede6fdd75d9d30f68255c7383d3a6226"}, - {file = "Sphinx-4.5.0.tar.gz", hash = "sha256:7bf8ca9637a4ee15af412d1a1d9689fec70523a68ca9bb9127c2f3eeb344e2e6"}, + {file = "Sphinx-5.3.0.tar.gz", hash = "sha256:51026de0a9ff9fc13c05d74913ad66047e104f56a129ff73e174eb5c3ee794b5"}, + {file = "sphinx-5.3.0-py3-none-any.whl", hash = "sha256:060ca5c9f7ba57a08a1219e547b269fadf125ae25b06b9fa7f66768efb652d6d"}, ] sphinx-gallery = [ - {file = "sphinx-gallery-0.10.1.tar.gz", hash = "sha256:953f32b0833b0a689ff33516d0866865fb8601c0626811b95d2e844286d207e4"}, + {file = "sphinx-gallery-0.11.1.tar.gz", hash = "sha256:56ccb29a0c2c4767d2a66617ba6ea7893e3a3885b6d972c62783a3b45b583ea5"}, + {file = "sphinx_gallery-0.11.1-py3-none-any.whl", hash = "sha256:b165cb366a5768a0f36e60e5bc6828fbf55fd1831e71645310167375223aa25c"}, ] sphinxcontrib-applehelp = [ {file = "sphinxcontrib-applehelp-1.0.2.tar.gz", hash = "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58"}, diff --git a/pyproject.toml b/pyproject.toml index 98f2bd3..7c06530 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,8 +9,8 @@ authors = [ ] license = "MIT" readme = "README.md" -homepage = "https://github.com/mad-lab-fau/mad-datasets" -repository = "https://github.com/mad-lab-fau/mad-datasets" +homepage = "https://github.com/mad-lab-fau/gaitmap-datasets" +repository = "https://github.com/mad-lab-fau/gaitmap-datasets" [tool.poetry.dependencies] python = ">=3.8,<4.0" @@ -28,16 +28,19 @@ pytest = "^7.2.0" pytest-cov = "^4.0.0" ipykernel = "^6.15.0" numpydoc = "^1.4.0" -Sphinx = "^4.2.0" -sphinx-gallery = "^0.10.1" recommonmark = "^0.7.1" memory-profiler = "^0.60.0" matplotlib = "^3.5.2" toml = "^0.10.2" -pydata-sphinx-theme = "^0.9.0" prospector = "^1.8.3" black = "^22.10.0" isort = "^5.10.1" +Sphinx = "^5.3.0" +sphinx-gallery = "^0.11.1" +pydata-sphinx-theme = "^0.12.0" + + +[tool.poetry.group.dev.dependencies] [build-system] requires = ["poetry-core>=1.0.0"] @@ -78,7 +81,7 @@ lint = { cmd = "prospector", help = "Lint all files with Prospector." } _check_black = "black . --check" _check_isort = "isort . --check" check = { sequence = ["_check_black", "_check_isort", "lint"], help = "Check all potential format and linting issues." } -test = { cmd = "pytest --cov=mad_datasets --cov-report=term-missing --cov-report=xml", help = "Run Pytest with coverage." } +test = { cmd = "pytest --cov=gaitmap_datasets --cov-report=term-missing --cov-report=xml", help = "Run Pytest with coverage." } version = { script = "_tasks:task_update_version()" } docs = { script = "_tasks:task_docs()" } upload_docs = { script = "_tasks:task_upload_docs()" }