search

aeye-lab / pymovements

A python package for processing eye movement data
https://pymovements.readthedocs.io
MIT License
70 stars 17 forks source link

sphinx automatic generation fails due to circular import #755

Open SiQube opened 4 months ago

SiQube commented 4 months ago

Current Behavior

tox -e docs fails due to warnings

Example warning:

 WARNING: Summarised items should not include the current module. Replace 'pymovements.dataset.Dataset' with 'Dataset'.

the change happened here.

Expected Behavior

automated documentation generation works again

Minimum acceptance criteria

tox -e docs work without pinning sphinx

Steps to Reproduce

  1. git apply 

    diff --git a/pyproject.toml b/pyproject.toml
index 80657f6..3d810ff 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -53,7 +53,7 @@ docs = [
"pybtex",
"pydata-sphinx-theme>=0.12",
"setuptools>=61.0.0",
-  "sphinx>=5.3.0,<7.4",
+  "sphinx>=5.3.0",
"sphinx-copybutton>=0.4.0",
"sphinx-favicon>=1.0.1",
"sphinx_design>=0.3.0",

  2. tox -e docs

SiQube commented 2 weeks ago

related to #773 I'll fix it today