Skip to content

integrate mkdocstrings-insiders features++ #1

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

Merged
merged 9 commits into from
Feb 13, 2024
Merged

Conversation

mmacy
Copy link
Owner

@mmacy mmacy commented Feb 13, 2024

  • Switches to mkdocstrings-insiders for summary tables and automatic doc gen of function overloads
  • Updated the doc gen script (gen_ref_nav.py) and regenerated the Markdown files
    • Added a workaround to ignore lib/azure.py because it busts the doc build (haven't investigated root cause - dunno if it's mkdocstrings or something else)
  • Split the README.md file into multi-page Get started section by using PyMdowns's Snippets

@mmacy mmacy changed the title integrate mkdocstrings-insiders features integrate mkdocstrings-insiders features++ Feb 13, 2024
@mmacy mmacy merged commit a91c142 into docs Feb 13, 2024
@mmacy mmacy deleted the docs-experiment-autogen branch February 13, 2024 05:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant