search

oprypin / mkdocs-gen-files

MkDocs plugin to programmatically generate documentation pages during the build
https://oprypin.github.io/mkdocs-gen-files
MIT License
98 stars 8 forks source link

Ensure urljoin behaviour is correct #13

Closed davfsa closed 2 years ago

davfsa commented 2 years ago

Upstream bugfix for https://github.com/mkdocstrings/mkdocstrings/pull/443/

I have attempted to write the necessary tests but the layout of the library is interfering a bit:

from mkdocs_gen_files import plugin
Traceback (most recent call last):
  File "/home/davfsa/coding/mkdocs-gen-files/tests/test_plugin.py", line 4, in <module>
    from mkdocs_gen_files import plugin
  File "<frozen importlib._bootstrap>", line 1075, in _handle_fromlist
  File "/home/davfsa/coding/mkdocs-gen-files/mkdocs_gen_files/__init__.py", line 20, in __getattr__
    return getattr(FilesEditor.current(), name)
  File "/home/davfsa/coding/mkdocs-gen-files/mkdocs_gen_files/editor.py", line 94, in current
    config = load_config("mkdocs.yml")
  File "/home/davfsa/coding/mkdocs-gen-files/.venv/lib/python3.10/site-packages/mkdocs/config/base.py", line 236, in load_config
    raise exceptions.Abort(
mkdocs.exceptions.Abort: Aborted with 3 Configuration Errors!

Not sure what the best way to fix this would be

oprypin commented 2 years ago

Thanks!

oprypin commented 2 years ago

I finally made a release with this. https://github.com/oprypin/mkdocs-gen-files/releases/tag/v0.3.5