You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The TOML tox specification of the docs environment uses the wrong syntax for specifying the commands to run - there should be an additional set of square brackets as commands is expected to be an array of arrays, each inner array corresponding to a single command (potentially consisting of multiple components).
Our mkdocs.yml configuration in the template is out of date with current MkDocs - specifically, inventories should now be specified with inventories rather than imports key, and docstring_style should live under handlers.python.options
Create an instance of template and run tox -e docs or mkdocs build
Expected Behaviour
No errors when attempting to build documentation site locally or on GitHub Actions
Actual Behaviour
A series of errors (first one from tox TOML config problem, latter two from mkdocs.yml issues
TypeError: 'mkdocs' is not list
TypeError: PythonConfig.__init__() got an unexpected keyword argument 'docstring_style'
INFO - FutureWarning: The 'import' key is renamed 'inventories' for the Python handler
File "causalprog/.tox/docs/lib/python3.13/site-packages/mkdocstrings/handlers/base.py", line 680, in get_handler
self._handlers[name] = module.get_handler(**kwargs)
File "causalprog/.tox/docs/lib/python3.13/site-packages/mkdocstrings_handlers/python/handler.py", line 361, in get_handler
warn("The 'import' key is renamed 'inventories' for the Python handler", FutureWarning, stacklevel=1)
Describe the Bug
While using template to create https://github.com/UCL/causalprog I came across a few issues with building MkDocs site
tox
specification of thedocs
environment uses the wrong syntax for specifying the commands to run - there should be an additional set of square brackets as commands is expected to be an array of arrays, each inner array corresponding to a single command (potentially consisting of multiple components).mkdocs.yml
configuration in the template is out of date with current MkDocs - specifically, inventories should now be specified withinventories
rather thanimports
key, anddocstring_style
should live underhandlers.python.options
Changes required to template are equivalent to those in
https://github.com/UCL/causalprog/compare/0e4d06c..130dbaa
To Reproduce
Create an instance of template and run
tox -e docs
ormkdocs build
Expected Behaviour
No errors when attempting to build documentation site locally or on GitHub Actions
Actual Behaviour
A series of errors (first one from
tox
TOML config problem, latter two frommkdocs.yml
issuesTypeError: 'mkdocs' is not list
TypeError: PythonConfig.__init__() got an unexpected keyword argument 'docstring_style'
Version In Use
v1.0.0-31-ga3003e2
Additional Context
The text was updated successfully, but these errors were encountered: