Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐞 Fix mkdocs related issues #195

Open
5 of 6 tasks
billsioros opened this issue Jul 6, 2023 · 0 comments
Open
5 of 6 tasks

🐞 Fix mkdocs related issues #195

billsioros opened this issue Jul 6, 2023 · 0 comments
Assignees
Labels
🐛 bug Something isn't working 📌 pinned This is important

Comments

@billsioros
Copy link
Owner

billsioros commented Jul 6, 2023

What happened?

Fix the following issues regarding mkdocs:

  • Configure watch directory via the new watch mkdocs option
  • Mkdocstrings __version__ deprecation warnings
  • MIT License logo should be replaced with the following code snippet:
<a href="https://opensource.org/licenses/MIT">
    <img align="left" src="https://i0.wp.com/opensource.org/wp-content/uploads/2023/03/cropped-OSI-horizontal-large.png?fit=640%2C229&ssl=1">
</a>

How can we reproduce the bug?

mkdocs serve

Relevant stack trace

INFO     -  Building documentation...
INFO     -  mkdocstrings: DEPRECATION: mkdocstrings' watch feature is deprecated in favor of MkDocs' watch feature,
            see https://www.mkdocs.org/user-guide/configuration/#watch
INFO     -  DeprecationWarning: 'version' is deprecated. Use '__version__' instead.
              File
            "/root/.cache/pypoetry/virtualenvs/roughml-4Ze8SC3I-py3.9/lib/python3.9/site-packages/markdown/__init__.py",
            line 51, in __getattr__
                warnings.warn(
              File
            "/root/.cache/pypoetry/virtualenvs/roughml-4Ze8SC3I-py3.9/lib/python3.9/site-packages/mdx_truly_sane_lists/__init__.py",
            line 1, in
                from .mdx_truly_sane_lists import makeExtension

Operating System (OS)

macOS, Windows, Linux

Python version

3.7, 3.8, 3.9

Is this a duplicate issue?

  • I confirm that this is not a duplicate issue

Have you upgraded to the latest version?

  • I confirm that I have upgraded to the latest version

Code of Conduct

  • I agree to follow this project's Code of Conduct
@billsioros billsioros added the 🐛 bug Something isn't working label Jul 6, 2023
@billsioros billsioros self-assigned this Jul 6, 2023
@billsioros billsioros changed the title 🐞 Deprecate mkdocstrings watch 🐞 Fix mkdocs related issues Jul 8, 2023
@github-actions github-actions bot added the 💀 stale This had no recent activity label Jul 18, 2023
@billsioros billsioros added 📌 pinned This is important and removed 💀 stale This had no recent activity labels Jul 20, 2023
Repository owner deleted a comment from github-actions bot Jul 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug Something isn't working 📌 pinned This is important
Projects
None yet
Development

No branches or pull requests

1 participant