Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-thumbnails
mkdocs-thumbnailsMkDocsplugin to generate thumbnails automatically.Provides a mechanism to indicate, in Markdown, the desire for PDF files and YouTube links to have a thumbnail image, automatically generated/downloaded.SetupInstall the plugin using pip:pip install mkdocs-thumbnailsEditmkdocs.yml:Addthumbnailsto the list of plugins.Addmarkdown.extensions.attr_list(explained here)to the list of markdown extensions:plugins:-search-thumbnails:# optional styling for the thumbnail:style:margin-top:5px;margin-bottom:5px;margin-right:25pxmarkdown_extensions:-markdown.extensions.attr_listNote:The extension If you have nopluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set, but now you have to enable it explicitly.More information about plugins in theMkDocs documentation.Configstyle- This is the CSS style to be set in the thumbnail's image tagUsageIn the attribute list of a link, add.pdfor.youtubeto turn on the thumbnail for that link:[My PDF file](foo.pdf){.pdf}⸱⸱
[A YouTube video link](https://youtu.be/dQw4w9WgXcQ){.youtube}⸱⸱The markdown conversion generates:<ahref="foo.pdf"class="pdf">My PDF file</a><br><ahref="https://youtu.be/dQw4w9WgXcQ"class="youtube">A YouTube video link</a><br>...which is converted by the plugin:<ahref="foo.pdf"><imgsrc="foo.pdf-thumb.png"class="pdf">My PDF file</a><br><ahref="https://youtu.be/dQw4w9WgXcQ"><imgsrc="dQw4w9WgXcQ-thumb.png"class="youtube">A YouTube video link</a><br>Thumbnails are generated automatically.  PDF links will have the first page of the PDF in the thumbnail.  YouTube thumbnails are downloaded from Youtube via the link:https://img.youtube.com/vi/{id}/default.jpgIn the example above two spaces are added after each line, to force a markdown line break.
Package: mkdocs-timetoread-plugin
mkdocs-timetoread-pluginmkdocs-timetoread-plugin is a lightweight'estimated time to read'generator for MkDocs inspired by @alanhamlett'sreadtimeand Medium'sread time formula.SetupInstall the plugin using pip:pip install mkdocs-timetoread-pluginActivate the plugin inmkdocs.yml:plugins:-search-timetoreadNote:If you have nopluginsentry in your config file yet, you'll likely also want to add thesearchplugin. MkDocs enables it by default if there is nopluginsentry set, but now you have to enable it explicitly.mkdocs.yml Configurationwpm- Sets the 'words per minute' value for calculating estimated read time.Default value is255Possible value range:1-999allPages- Sets all markdown files to have their read times' calculated unless explicitly disabled in the files' Front Matter.Default value isTruePossible values:TrueorFalsetextColor- Sets the CSS color for styling the 'Estimated read time:' text.Default value isbdbdbdPossible value range:000000-ffffffExample Configurationplugins:-timetoread:wpm:190allPages:TruetextColour:000000Front MatterOther configuration options are available by defining the following in a YAML front matter block in each markdown file.// Disable timetoread on a per file basis if `allPages is set to Truetimetoread:False// Enable timetoread on a per file basis if `allPages` is set to Falsetimetoread:TrueUsageOnce activatedmkdocs-timetoread-pluginwill automatically add a new line, with the estimated time to read the document, after the</h1>tag in the HTML output generated by MkDocs.
Package: mkdocs-title-casing-plugin
mkdocs-title-casing-pluginA lightweight mkdocs plugin to add title casing to all mkdocs pages and sections.
Usespython-titlecasefor formatting.SetupInstall the plugin using pip:pipinstallmkdocs-title-casing-pluginInclude the plugin inmkdocs.yml. For example:plugins:
  - search
  - title-casingIf this is the firstpluginsentry that you are adding, you should probably also addsearchas this is enabled by default.UsageWhen the plugin is enabled, all section and page titles will be converted to use Title Case. For example,War and peacebecomesWar and Peace.Configurationcapitalization_type(string)title- default - givesWar and Peace.first_letter- givesWar And Peace.default_page_name(string). The page name to use when it cannot be determined automatically. Default isHome.Example mkdocs.ymlplugins:
  - search
  - title-casing:
      capitalization_type: first_letter
      default_page_name: Index
Package: mkdocs-toggle-sidebar-plugin
mkdocs-toggle-sidebar-pluginThis package allows you to toggle the left (navigation) and right (table of contents) sidebars on a couple of MkDocs themes such as:Material for MkDocs:materialBuiltin themes:mkdocs,readthedocsYou can play around with it and these themes on thetest page.The settings are stored using thelocalStorageobject, so that it will persist between pages.I wrote it after getting frustrated by the browser'sFind in pagefunction matching way to many links in the navigation sidebar instead of searching in the actual page's content.UsageSetupFirst install the PyPI package:pipinstallmkdocs-toggle-sidebar-pluginAdd something like the following to yourmkdocs.yml:plugins:-search-toggle-sidebarKey bindingsThe plugin adds the following key bindings:KeyActionbtoggleboth (TOC and navigation)mtoggle navigationmenuttoggleTOCTheme supportThemeTheme versionPlugin versionStatusmkdocs-material9.1.210.0.1worksmkdocs (default)1.5.20.0.2worksreadthedocs1.5.20.0.2worksJust open a issue / PR if you use a strange theme or the info above is not up to date anymore.Note to selfTest mkdocs-material theme:./serve.shTest mkdocs theme:./serve.sh--thememkdocsNotable changesVersion 0.0.3Changed internal API:Element hiding/restyling is now done via CSS, so it is easier to undo. You should no longer have problems on devices with small screens (like phones) having broken layouts.Version 0.0.2Added support formkdocsandreadthedocstheme.Version 0.0.1Prototype withmkdocs-materialimplementation.
Package: mkdocs-traefiklabs
ATraefik LabsMaterial Designtheme forMkDocsQuick startMaterial for MkDocs can be installed withpip:pipinstallmkdocs-traefiklabsAdd the following line tomkdocs.yml:theme:name:traefik-labsHow to run the project in Dev modePre-requisitesCheck your node version, the .nvmrc file mentions the expected version.
If you use nvm, you can runnvm useto set the correct node version to the environment.Check if you havemkdocsinstalled locally (it requires Python).
You can find installation instructions here:https://www.mkdocs.org/user-guide/installation/Steps:Install the dependenciesnpm installnpm run build- this will generate the '/material' folder with the compiled theme (you need to re-run this if you add assets)npm run start- leave this running in a terminal, it will watch for code changes and rebuild the content (but not the assets)npm run serve- will launch a dev server at 127.0.0.1:8000 with the current theme, it has hot reload (not very precise, sometimes you need to hard refresh the page)If you wish to set the context to see other products information, you need to set theproductconfig in themkdocs.ymlfile in the project's root directory. The dev server should automatically reload and you will see the changes in the browser.Reminders:The 'material' directory generated by thenpm run buildis the one used in the documentation, so please don't forget running the build once you finish all the changes.
TODO: add git hooks and run build on pre-push.
Package: mkdocs-translations
Mkdocs translations pluginThis plugin is inspired bymkdocs-static-i18nplugin,
but it solves problem with tabs. With it, you can use nested documentation file structure.Also, it's integrated with mkdocs-material theme features.
Such assearch,language switcher,
andtabs.For example, with the following configuration:# Add this plugin in your mkdocs.ymlplugins:-translations:default_language:rulanguages:en:englishru:русскийIt will turn this.docs
├── Dir1
│   ├── index.md
│   ├── index.en.md
│   ├── Theme1.md
│   ├── Theme1.en.md
│   ├── Theme2.md
│   └── Theme2.en.md
├── index.en.md
├── index.md
└── Dir2
    ├── index.md
    ├── index.en.md
    ├── Theme1.md
    └── Theme1.en.mdInto this:site
├── 404.html
├── index.html
├── Dir1
│   ├── Theme1
│   │   └── index.html
│   ├── index.html
│   └── Theme2
│       └── index.html
├── Dir2
│   ├── Theme1
│   │   └── index.html
│   └── index.html
├── en
│   ├── Dir1
│   │   ├── Theme1
│   │   │   └── index.html
│   │   ├── index.html
│   │   └── Theme2
│   │       └── index.html
│   ├── index.html
│   └── Dir2
│       ├── Theme1
│       │   └── index.html
│       └── index.html
└── ru
    ├── Dir1
    │   ├── Theme1
    │   │   └── index.html
    │   ├── index.html
    │   └── Theme2
    │       └── index.html
    ├── index.html
    └── Dir2
        ├── Theme1
        │   └── index.html
        └── index.html
Package: mkdocstrings
mkdocstringsAutomatic documentation from sources, forMkDocs.
Come have a chat or ask questions on ourGitter channel.Features-Requirements-Installation-Quick usageFeaturesLanguage-agnostic:just likeMkDocs,mkdocstringsis written in Python but is language-agnostic.
It means you can use it with any programming language, as long as there is ahandlerfor it.
We currently havehandlersfor theCrystalandPythonlanguages,
as well as forshell scripts/libraries.
Maybe you'd like to add another one to the list? :wink:Multiple themes support:each handler can offer multiple themes. Currently, we offer the
:star:Material theme:star:
as well as basic support for the ReadTheDocs and MkDocs themes for the Python handler.Cross-references across pages:mkdocstringsmakes it possible to reference headings in other Markdown files with the classic Markdown linking
syntax:[identifier][]or[title][identifier]-- and you don't need to remember which exact page this object was
on. This works for any heading that's produced by amkdocstringslanguage handler, and you can opt to includeanyMarkdown heading into the global referencing scheme.Note: in versions prior to 0.15allMarkdown headers were included, but now you need toopt in.Cross-references across sites:similarly toSphinx's intersphinx extension,mkdocstringscan reference API items from other libraries, given they provide an inventory and you load
that inventory in your MkDocs configuration.Inline injection in Markdown:instead of generating Markdown files,mkdocstringsallows you to inject
documentation anywhere in your Markdown contents. The syntax is simple:::: identifierfollowed by a 4-spaces
indented YAML block. The identifier and YAML configuration will be passed to the appropriate handler
to collect and render documentation.Global and local configuration:each handler can be configured globally inmkdocs.yml, and locally for each
"autodoc" instruction.Reasonable defaults:you should be able to just drop the plugin in your configuration and enjoy your auto-generated docs.Used bymkdocstringsis used by well-known companies, projects and scientific teams:Ansible,Apache,Google,Jitsi,Microsoft,Prefect,Pydantic,and more...InstallationWithpip:pipinstallmkdocstringsYou can install support for specific languages using extras, for example:pipinstall'mkdocstrings[crystal,python]'See theavailable language handlers.Withconda:condainstall-cconda-forgemkdocstringsQuick usageInmkdocs.yml:site_name:"MyLibrary"theme:name:"material"plugins:-search-mkdocstringsIn one of your markdown files:# Reference::: my_library.my_module.my_classSee theUsagesection of the docs for more examples!
Package: mkdocstrings-crystal
mkdocstrings-crystalCrystallanguage doc generator forMkDocs, viamkdocstringsIntroductionmkdocstrings-crystalallows you to insert API documentation (generated fromCrystal's source code and doc comments) as part of any page on aMkDocssite.See it in action.To install it, run (possibly in avirtualenv):pipinstallmkdocstrings-crystalContinue to thedocumentation site.UsageWithMkDocs, add/merge this base config as yourmkdocs.yml:site_name:My Projecttheme:name:materialplugins:-search-mkdocstrings:default_handler:crystalmarkdown_extensions:-pymdownx.highlight-deduplicate-tocThen, in anydocs/**/*.mdfile, you canmention a Crystal identifier alone on a line, after::::::: MyClass

::: Other::Class#some_method

::: Foo::CONSTANT-- and in the output this will be replaced with generated API documentation for it, much like Crystal's own doc generator does.This, of course, happens as part of a normal MkDocs build process:mkdocsbuild# generate from docs/ into site/mkdocsserve# live previewContinue to thedocumentation site.
Package: mkdocstrings-pac
MkDocs for PACThis Package is a MkDocs plugin for the PAC (Point and Click) game engine.
It's generates the LUA docs from lua.cpp.Buildpython3-mpipinstall--upgradebuild
python3-mbuildInstallpy-mpipinstalldist/mkdocstrings_pac-0.0.0-py3-none-any.whl--force-reinstallFor developmentpy-mbuild&&py-mpipinstalldist/mkdocstrings_pac-1.0.2-py3-none-any.whl--force-reinstallMore docshttps://packaging.python.org/en/latest/tutorials/packaging-projects/
Package: mkdocstrings-python
mkdocstrings-pythonA Python handler formkdocstrings.The Python handler usesGriffeto collect documentation from Python source code.
The word "griffe" can sometimes be used instead of "signature" in French.
Griffe is able to visit the Abstract Syntax Tree (AST) of the source code to extract useful information.
It is also able to execute the code (by importing it) and introspect objects in memory
when source code is not available. Finally, it can parse docstrings following different styles.InstallationYou can install this handler as amkdocstringsextra:# PEP 621 dependencies declaration# adapt to your dependencies manager[project]dependencies=["mkdocstrings[python]>=0.18",]You can also explicitly depend on the handler:# PEP 621 dependencies declaration# adapt to your dependencies manager[project]dependencies=["mkdocstrings-python",]PreviewFeaturesData collection from source code: collection of the object-tree and the docstrings is done thanks toGriffe.Support for type annotations:Griffe collects your type annotations andmkdocstringsuses them
to display parameter types or return types. It is even able to automatically add cross-references
to other objects from your API, from the standard library or third-party libraries!
Seehow to load inventoriesto enable it.Recursive documentation of Python objects:just use the module dotted-path as an identifier, and you get the full
module docs. You don't need to inject documentation for each class, function, etc.Support for documented attributes:attributes (variables) followed by a docstring (triple-quoted string) will
be recognized by Griffe in modules, classes and even in__init__methods.Multiple docstring-styles support:common support for Google-style, Numpydoc-style,
and Sphinx-style docstrings. SeeGriffe's documentationon docstrings support.Admonition support in Google docstrings:blocks likeNote:orWarning:will be transformed
to theiradmonitionequivalent.We do not support nested admonitions in docstrings!Every object has a TOC entry:we render a heading for each object, meaningMkDocspicks them into the Table
of Contents, which is nicely displayed by the Material theme. Thanks tomkdocstringscross-reference ability,
you can reference other objects within your docstrings, with the classic Markdown syntax:[this object][package.module.object]or directly with[package.module.object][]Source code display:mkdocstringscan add a collapsible div containing the highlighted source code
of the Python object.
Package: mkdocstrings-python-generator
mkdocstrings-python-generatormkdocstrings-python-generator is a mkdocs plugin for generating markdown pages automatically from python source code.It is intended to fill a gap which is currently left to each user of mkdoctstings-python.  Namely: generating markdown
files for each python file.Note despite the name there is no affiliation between mkdocstrings and mkdocstrings-python-generator. Please try to
determine which plugin is to blame before posting issues here orthere.Project StatusThis project is in a  very phase of development and not yet recomended for production.
Package: mkdocstrings-python-legacy
mkdocstrings-python-legacyThe legacy Python handler formkdocstrings.WARNING: We suggest using the new handler instead:mkdocstrings-python.InstallationYou can install this handler as amkdocstringsextra:# PEP 621 dependencies declaration# adapt to your dependencies manager[project]dependencies=["mkdocstrings[python-legacy]>=0.18",]You can also explicitely depend on the handler:# PEP 621 dependencies declaration# adapt to your dependencies manager[project]dependencies=["mkdocstrings-python-legacy",]PreviewFeaturesData collection from source code: collection of the object-tree and the docstrings is done thanks topytkdocs.Support for type annotations:pytkdocs collects your type annotations andmkdocstringsuses them
to display parameters types or return types.Recursive documentation of Python objects:just use the module dotted-path as identifier, and you get the full
module docs. You don't need to inject documentation for each class, function, etc.Support for documented attributes:attributes (variables) followed by a docstring (triple-quoted string) will
be recognized by Griffe in modules, classes and even in__init__methods.Multiple docstring-styles support:common support for Google-style, Numpydoc-style,
and Sphinx-style docstrings.Admonition support in Google docstrings:blocks likeNote:orWarning:will be transformed
to theiradmonitionequivalent.We do not support nested admonitions in docstrings!Every object has a TOC entry:we render a heading for each object, meaningMkDocspicks them into the Table
of Contents, which is nicely display by the Material theme. Thanks tomkdocstringscross-reference ability,
you can reference other objects within your docstrings, with the classic Markdown syntax:[this object][package.module.object]or directly with[package.module.object][]Source code display:mkdocstringscan add a collapsible div containing the highlighted source code
of the Python object.
Package: mkdocstrings-python-xref
mkdocstrings-python-xrefPython handler formkdocstringssupporting relative cross-references.mkdocstringsis an awesome plugin forMkDocsthat can generate Markdown API documentation
from comments in code. The standardpython handlerallows you to
create cross-reference links using the syntax[<title>][<path>]where the path must
either be the fully qualified name of the referent or is empty, in which case the path
is taken from the title. This works well when the names are short, but can be burdensome
in larger codebases with deeply nested package structures.This package extendsmkdocstrings-pythonto support a relative cross-reference syntax,
that allows you to write doc-strings with cross-references like:classMyClass:defthis_method(self):"""See [other_method][..] from [MyClass][(c)]"""rather than:classMyClass:defthis_method(self):"""See [other_method][mypkg.mymod.MyClass.other_method]from [MyClass][mypkg.mymod.Myclass]"""Another benefit of this extension is that it will report source locations for bad references
so that errors are easier to find and fix. For example:$mkdocsbuild
INFO-Cleaningsitedirectory
INFO-Buildingdocumentationtodirectory:/home/jdoe/my-project/site
WARNING-mkdocstrings_handlers:file:///home/jdoe/my-project/src/myproj/bar.py:16:Cannotloadreference'myproj.bar.bad'For further details, please see theDocumentation
Package: mkdocstrings-sourcelink
mkdocstrings-sourcelinkAutomatic source link generation formkdocstringsOverviewmkdocstrings-sourcelinkis a source link generator formkdocstrings, which allows connecting the source code to a repository independent of the host (GitHub,GitLab, own Services).The original idea ofmkdocstrings-sourcelinkwas coming fromkeras-autodocand used as inspiration. However, this implementation focuses on using straightmkdocstringsand not rephrase docstrings into the documentation. Furthermore,mkdocstrings-sourcelinkalso allows:Generating API listUsing templates and examplesImporting existing markdown files likeREADME.mdInstallationpipinstallmkdocstrings-sourcelinkUsageThe usage requires just three steps:❯ python generate_docs.py❯ mkdocs.yml❯ mkdocs deploy
Package: mkdocs-twincat-doc-plugin
mkdocs-twincat-doc-pluginMkDocs plugin to import retrieve docstrings from TwinCAT project objects and add to docs.Developing mkdocs-twincat-doc-pluginTo install mkdocs-twincat-doc-plugin, along with the tools you
need to develop and run tests, run the following in your virtualenv:$pipinstall-e.[dev]
Package: mkdocs-typedoc
Mkdocs-Typedoc PluginThe Mkdocs-Typedoc Plugin is designed to integrate TypeDoc documentation with your MkDocs project.InstallationInstall the plugin using pip fromPyPI:pipinstallmkdocs-typedocEnsure that you haveNode.jsinstalled in your system. If not, you can download it from the official website.Also, installTypeDocusingNPM:npminstalltypedoctypescript--save-devUsageAdd the following lines to your mkdocs.yml:plugins:-typedoc:source:'./ts-examples/@types/*.d.ts'output_dir:'typedocApi'tsconfig:'./ts-examples/tsconfig.json'options:'typedoc.json'name:'APIDoc'disable_system_check:Falsesource(required): The path to your TypeScript source code.output_dir(optional): The directory where you want to output your docs. Default is "typedoc".tsconfig(required): The path to the tsconfig file for your project.options(optional): The path to the typedoc.json options file with more options.name(optional): The name for the generated documentation. Default is "TypeDoc API".disable_system_check(optional): Disable the TypeScript system check. Default is False.The plugin will generate TypeDoc documentation into the output directory specified.ContributingPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.Do You Enjoy My Work?Then definitely consider:supporting me on GitHub Sponsors:LicenseMIT
Package: mkdocs-typer
mkdocs-typerAn MkDocs extension to generate documentation for Typer command line applications.InstallationInstall from PyPI:pipinstallmkdocs-typerQuickstartAddmkdocs-typerto Markdown extensions in yourmkdocs.ymlconfiguration:site_name:Exampletheme:readthedocsmarkdown_extensions:-mkdocs-typerAdd a CLI application, e.g.:# app/cli.pyimporttypermy_app=typer.Typer()@my_app.command()deffoo():"""do something fooey"""@my_app.callback()defcli():"""Main entrypoint for this dummy program"""Add amkdocs-typerblock in your Markdown:# CLI ReferenceThis page provides documentation for our command line tools.

::: mkdocs-typer
    :module: app.cli
    :command: cliStart the docs server:mkdocsserveTada! 💫UsageDocumenting commandsTo add documentation for a command, add amkdocs-typerblock where the documentation should be inserted.Example:::: mkdocs-typer
    :module: app.cli
    :command: mainFor all available options, see theBlock syntax.Multi-command supportWhen pointed at a group (or any other multi-command),mkdocs-typerwill also generate documentation for sub-commands.This allows you to generate documentation for an entire CLI application by pointingmkdocs-typerat the root command.Tweaking header levelsBy default,mkdocs-typergenerates Markdown headers starting at<h1>for the root command section. This is generally what you want when the documentation should fill the entire page.If you are inserting documentation within other Markdown content, you can set the:depth:option to tweak the initial header level. Note that this applies even if you are just adding a heading.By default it is set to0, i.e. headers start at<h1>. If set to1, headers will start at<h2>, and so on. Note that if you insert your own first level heading and leave depth at its default value of 0, the page will have multiple<h1>tags, which is not compatible with themes that generate page-internal menus such as the ReadTheDocs and mkdocs-material themes.ReferenceBlock syntaxThe syntax formkdocs-typerblocks is the following:::: mkdocs-typer
    :module: <MODULE>
    :command: <COMMAND>
    :prog_name: <PROG_NAME>
    :depth: <DEPTH>Options:module: path to the module where the command object is located.command: name of the command object.prog_name:(Optional, default: same ascommand)the name to display for the command.depth:(Optional, default:0)Offset to add when generating headers.Changelog