Skip to content

Commit

Permalink
Fixed docu and final other renames
Browse files Browse the repository at this point in the history
  • Loading branch information
AKuederle committed Dec 13, 2022
1 parent 33d4256 commit eef31e4
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 38 deletions.
9 changes: 5 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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",),
Expand All @@ -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}",
)

6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
50 changes: 26 additions & 24 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 9 additions & 6 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"]
Expand Down Expand Up @@ -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()" }
Expand Down

0 comments on commit eef31e4

Please sign in to comment.