Saravanan666/pypi-org huggingface dataset:
Package: mkdocs_puml
mkdocs_pumlis a fast and simple package that brings plantuml diagrams to MkDocs
documentation.InstallRun the following command to install the packagepipinstallmkdocs_pumlHow to useJust addplantumlplugin intopluginssection of yourmkdocs.ymlfile,
in order to use puml with mkdocs.plugins:-plantuml:puml_url:https://www.plantuml.com/plantuml/plantumlplugin usesPlantUMLonly as an HTTP service. So, you should necessarily
specifypuml_urlconfig.Theplantumlconfig with the full list of parameters is belowplugins:-plantuml:puml_url:https://www.plantuml.com/plantuml/num_workers:8puml_keyword:pumlWhereParmeterTypeDescriptonpuml_urlstr. RequiredURL to the plantuml servicenum_workersint. Default8Max amount of concurrent workers that request plantuml servicepuml_keywordstr. DefaultpumlThe keyword for PlantUML code fence, i.e. ```puml ```Now, you can put your puml diagrams into your.mddocumentation. For example,## PUML Diagram

```puml
@startuml
Bob -> Alice : hello
@enduml
```At the build stepmkdocssends requests topuml_urland substitutes your
diagram with thesvgimages from the responses.Run PlantUML service with DockerIt is possible to runplantuml/plantuml-serveras a Docker container.Add a new service to thedocker-compose.ymlfileversion:"3"services:puml:image:plantuml/plantuml-serverports:-'8080:8080'Then substitutepuml_urlconfig with the local URL in themkdocs.ymlfileplugins:-plantuml:puml_url:http://127.0.0.1:8080num_workers:8Obviously, this approach works faster than
using remoteplantuml.com.Standalone usageYou can usePlantUMLconverter withoutmkdocs. Below is the example,frommkdocs_puml.pumlimportPlantUMLpuml_url="https://www.plantuml.com/plantuml"diagram1="""@startumlBob -> Alice : hello@enduml"""diagram2="""@startumlJon -> Sansa : hello@enduml"""puml=PlantUML(puml_url,num_worker=2)svg_for_diag1,svg_for_diag2=puml.translate([diagram1,diagram2])How it worksThe package uses PlantUML as an HTTP service. It sends GET requests to
PlantUML service and receivessvgimages representing the diagrams.Theplantumlplugin parses.mddocumentation files and looks for```puml

```code blocks. Whenpumlcode block is found it is saved to the buffer for
a later request to PlantUML service. In this step, we replacepumlblock
with the uuid.NOTEyou must setpumlkeyword as an indicator that the PlantUML diagram
is located in the block. Default keyword can be changed for the custom one
inmkdocs.ymlconfig file by usingpuml_keywordparameter.After all pages are parsed,plantumlplugin requests PlantUML service
with the collected diagrams. After the responses are received, the package
substitutes uuid codes in markdown files with the correspondingsvgimages.LicenseThe project is licensed underMIT license.Diagram icon created byFreepik.
Package: mkdocs-pydoc
mkdocs-pydoc![Build Status](https://travis-ci.org/noirbizarre/mkdocs-pydoc)![Maintainability](https://codeclimate.com/github/noirbizarre/mkdocs-pydoc/maintainability)![Test Coverage](https://codeclimate.com/github/noirbizarre/mkdocs-pydoc/test_coverage)![Last version](https://pypi.python.org/pypi/mkdocs-pydoc)![License](https://pypi.python.org/pypi/mkdocs-pydoc)![Supported Python versions](https://pypi.python.org/pypi/mkdocs-pydoc)Python documentation for MkDocsChangelogCurrentIn development
Package: mkdocs-pyscript
mkdocs-pyscriptmkdocs-pyscriptis a plugin formkdocsthat allows you to transformcode blocksinto executable Python scripts that run in the user's browser, with no backend server, usingPyScript.InstallationInstall the plugin into your environment usingpip, or your favorite environment manager that ues PYPI:pip3installmkdocs-pyscriptEnable the plugin by adding it tomkdocs.yaml:plugins:
    - mkdocs-pyscriptUsageWith this plugin enabled, all Pythonfenced code blocks(typepyorpythonor any other label that maps tolang-python) will have an added LOAD button in the lower-right corrner. When clicked, the code block will be transformed into an editable code snippet (usingcodemirror). When the user clicks on the green "run" arrow in the lower right corner, or pressed SHIFT+ENTER when focused, will run the inner Python code using PyScript.The included code is run in aWeb Worker, so as not to block the main thread. Each snippet is run in a separate web worker; variables, objects, and names are not shared between executions of the same cell.preandpostcodeSome demo code snippets may require setup and/or teardown code to properly function, which don't necessarily need to be displayed to the user. To run a chunk of Python code before any code the user runs in a particular code editor, add the.py-preclass to a fenced code block immediately before the user-visible code block, using the style of theattr_listmarkdown plugin. To run a chunk of code after a user runs a particular code editor add the.py-postclass to a fenced code block immediately after the user-visible code block:```{.py .py-pre}
print("This is some pre-code")
```

```py
print("This is the main tag")
# Only this code will be displayed in the code editor
```

```{.py .py-post}
print("This is some post code")
```Configurationmkdocs-pyscriptsupports  options that can be set inmkdocs.yamlto control the behavior of the pluginpyscript_versionThepyscript_versionproperty of the plugin controls the version of PyScript that is loaded. If not specified, the current default version issnapshots/2023.09.1.RC2.To support both pre-release snapshots and released versions of PyScript, the provided value is inserted into the following string:SCRIPT=f'https://pyscript.net/{pyscript_version}/core.js'That is, to load a specific release or snapshot, use:#Load a releaseplugins:-mkdocs-pyscript:pyscript_version:"releases/2023.11.1"#Load a snapshotplugins:-mkdocs-pyscript:pyscript_version:"snapshots/2023.11.1.RC3"#Load the most recent (unstable) build:plugins:-mkdocs-pyscript:pyscript_version:"unstable"selectiveBy default,mkdocs-pyscriptturnsallblocks with typepyorpythoninto exectuable code snippets. To cause only selected blocks to be transformed:Set theselectiveproperty totrue:plugins:-mkdocs-pyscript:selective:trueSpecify.pyscriptas an additional class for the codeblocks that you want to be runnable:```{.py.pyscript}print("Hello, world!")```
Package: mkdocs-python-classy
mkdocs-python-classyOverviewA MkDocs plugin that helps you navigate the infuriating challenge of understanding a nested a Python class object. Trying to determine what attributes are available or what method does the class provide, and ultimately understanding the entire MRO (Method Resolution Order).ScreenshotsThe library works like any other mkdocs plugin.From here you can see how the MRO is described, links to other Classes covered in the docs, and a convenience Python import config.From here you can see the details of the attributes on the class.From here you can see how the code of the method is shown with line numbers, it is collapsible, and will even show multiple if the method is provided in multiple Classes in the MRO order! Additionally you can see the naviagation pane that is auto generated.DocumentationFull web-based HTML documentation for this library can be found over on themkdocs-python-classy Docswebsite:User Guide- Overview, Using the library, Getting Started.Administrator Guide- How to Install, Configure, Upgrade, or Uninstall the library.Developer Guide- Extending the library, Code Reference, Contribution Guide.Release Notes / Changelog.Frequently Asked Questions.Contributing to the DocsAll the Markdown source for the library documentation can be found under thedocsfolder in this repository. For simple edits, a Markdown capable editor is sufficient - clone the repository and edit away.If you need to view the fully generated documentation site, you can build it withmkdocs. A container hosting the docs will be started using the invoke commands (details in theDevelopment Environment Guide) onhttp://localhost:8001. As your changes are saved, the live docs will be automatically reloaded.Any PRs with fixes or improvements are very welcome!AttributionThis project is largely based on the work ofClassy Class-Based Views.andClassy Django REST Framework, see -Attributionfor more details.Questions
Package: mkdocs-quiz
MkDocs Quiz PluginDemoCreate your first quiz<?quiz?>
question:Areyouready?
answer-correct:Yes!
answer:No!
answer:Maybe!
content:
<h2>Providesomeadditionalcontent</h2>
<?/quiz?>InfoThe answers can get styled with HTML (like<code>Yes!</code>)WarningThe quiz content needs to be validHTMLMultiple choiceYou can also create a multiple choice quiz, by providing multiple answers as correct.<?quiz?>
question:Areyouready?
answer-correct:Yes!
answer:No!
answer-correct:Maybe!
content:
<h2>Providesomeadditionalcontent</h2>
<?/quiz?>ScreenshotsQuiz (single choice)Quiz (multiple choice)Disable for a page---quiz: disable---
Package: mkdocs-rebalance-theme
mkdocs-rebalance-themeRebalance theme for mkdocs.  Based off ofhttps://github.com/Automattic/themes/tree/master/rebalanceRecommend installing mkdocs-paginate-plugin for best results.Example from this project:https://kubilus1.github.io/mkdocs-rebalance-theme/LayoutThis is intended for a typical blog style layout.  A top level 'index.md' is
expected, but basically ignored.  Posts can be in a subdir or in the top level
directory.  All files will be collected and treated as posts.ExtrasThis theme supports a few special yaml config items in your posts such as:index: <int>This allows you to control the layout of posts.  These will be sorted in
reverse order.  As you add new posts you can expect the greatest number/newest
to be first.featured_image: <path>Adds a featured image to a post.  This should be relative to the top level of
the site_url.  Leave off any beginning/tags: [<list of tags>]Adds lists of tags on the homepage for each post.  This may be used at a later
point to show pages of matching tags.author: <name>Show the post's author.  This may be used in the future to provide a page of
matching articles.date: <date>Show the date of a post.
Package: mkdocs-redirects
mkdocs-redirectsPlugin formkdocsto create page redirects (e.g. for moved/renamed pages).Initially developed byDataRobot.InstallingNote:This package requires MkDocs version 1.0.4 or higher.Install with pip:pipinstallmkdocs-redirectsUsingTo use this plugin, specify your desired redirects in the plugin'sredirect_mapssetting in yourmkdocs.yml:plugins:-redirects:redirect_maps:'old.md':'new.md''old/file.md':'new/file.md''some_file.md':'http://external.url.com/foobar'Note: don't forget that specifying thepluginssetting will override the defaults if you didn't already have it set! Seethis pagefor more information.The redirects map should take the form of a key/value pair:The key of each redirect is the originalmarkdown doc(relative to thedocs_dirpath).This plugin will handle the filename resolution during themkdocs buildprocess.
This should be set to what the original markdown doc's filename was (or what itwould beif it existed), not the final HTML file rendered by MkDocsThe value is theredirect target. This can take the following forms:Path of themarkdown docyou wish to be redirected to (relative todocs_dir)This plugin will handle the filename resolution during themkdocs buildprocess.
This should be set to what the markdown doc's filename is, not the final HTML file rendered by MkDocsExternal URL (e.g.http://example.com)During themkdocs buildprocess, this plugin will create.htmlfiles insite_dirfor each of the "old" file that redirects to the "new" path.
It will produce a warning if any problems are encountered or of the redirect target doesn't actually exist (useful if you havestrict: trueset).use_directory_urlsIf you haveuse_directory_urls: trueset (which is the default), this plugin will modify the redirect targets to thedirectoryURL, not theactualindex.htmlfilename.
However, it will create theindex.htmlfile for each target in the correct place so URL resolution works.For example, a redirect map of'old/dir/README.md': 'new/dir/README.md'will result in an HTML file created at$site_dir/old/dir/index.htmlwhich redirects to../../new/dir/.Additionally, a redirect map of'old/dir/doc_name.md': 'new/dir/doc_name.md'will result in$site_dir/old/dir/doc_name/index.htmlredirecting to../../new/dir/doc_name/.This mimics the behavior of how MkDocs builds the site dir without this plugin.DevelopingSetup a virtualenvCreate a virtualenv using a method of your choice.brewinstallpyenvpyenv-virtualenv
pyenvinstall2.7.18
pyenvvirtualenv2.7.18mkdocs-redirects
pyenvactivatemkdocs-redirectsBuildmakebuildTestmaketestReleasingmakereleaseIt will prompt you for your PyPI user and password.See:https://packaging.python.org/tutorials/packaging-projects/https://packaging.python.org/guides/migrating-to-pypi-org/
Package: mkdocs-redoc-tag
MkDocs Redoc TagA MkDocs plugin supports addingRedocto the page.FeaturesOpenAPI Specification file from online over URL or static file in docsAll dependencies are using static files handled by the plugin not from CDN, especially suitable for those documents been deployed in the intranetSynchronized dark mode withMaterial for MkDocsDependencyPython Packagebeautifulsoup4>=4.11.1Redoc standalone javascript fromofficial CDNredoc==2.1.3UsageInstall the plugin from Pypipipinstallmkdocs-redoc-tagAddredoc-tagplugin into your mkdocs.yml plugins sections:plugins:-redoc-tagAddredoctag in markdown to include Redoc:<redocsrc="https://petstore.swagger.io/v2/swagger.json"/>You may customize the plugin by passing options in mkdocs.yml:plugins:-redoc-tag:background:WhiteOptionsTypeDescriptionbackgroundStringDefault: "". Redoc iframe body background attribute value. You can use any css value for background for example "#74b9ff" or "Gainsboro" or "" for nothing.heightStringDefault: "80vh". Height of Redoc iframe.How it worksCopy Redoc script file intosite/assets/javascripts/directorySearch all redoc tags, then convert them to an iframe tag and generate the iframe target html with the given OpenAPI Specification src pathLicenseThis project is licensed under the MIT License - see theLICENSE.mdfile for details.Referenceredark: source of dark mode javascript and css
Package: mkdocs-render-otherfile-plugin
mkdocs-render-otherfile-pluginMkDocsplugin to render other format files in mkdocs build. This only affects your rendered HTML and does not affect the markdown files.SetupInstall the plugin using pip3:pip3installmkdocs-render-otherfile-pluginNext, add the following lines to yourmkdocs.yml:plugins:
  - search
  - render-otherfileIf 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.UsageExample of multiple options set in themkdocs.ymlfile:plugins:
    - search
    - render-otherfile
        ext:
            - .c
            - .cpp
            - .pyOptionsext: files ext render in mkdocs build process.
Package: mkdocs-render-swagger-plugin
mkdocs-render-swagger-pluginThis is theMkdocsplugin for rendering swagger & openapi schemas usingSwagger UI. It is written in Python.UsageInstall the plugin usingpip install mkdocs-render-swagger-plugin.Add the following lines to your mkdocs.yml:plugins:
  - render_swaggerExampleHere's anexample(courtesy of Scarf) of how the plugin renders swagger.Referencing a local jsonPlace an OpenAPI json file in the same folder as the.mdfile.Enter!!swagger FILENAME!!at the appropriate location inside the markdown file.If you wish to reference any files on the filesytem (security risk), make sure
you enableallow_arbitrary_locationsin the config (mkdocs.yml) like so:plugins:
  - render_swagger:
      allow_arbitrary_locations : trueReferencing an external jsonYou may reference an external OpenAPI json using the following syntax:!!swagger-http URL!!.Explicit declaration of the Swagger JS libraryYou can explicitly specify the swagger-ui css and js dependencies if you wish to not use the unpkg CDN.To specify this usejavascriptandcssin your mkdocs.yaml:plugins:-render_swagger:javascript:assets/js/swagger-ui-bundle.jscss:assets/css/swagger-ui.cssContributing & Developing LocallyAfter downloading and extracting the.tar.gz, install this package locally usingpipand the--editableflag:pipinstall--editable".[dev]"You'll then have therender-swaggerpackage available to use in Mkdocs andpipwill point the dependency to this folder. You are then able to run the docs usingmkdocs serve. Make sure you restart the process between code changes as the plugin is loaded on startup.MkDocs plugins and Swagger apiThe Render Swagger MkDocs plugin uses a set of extensions and plugin APIs that MkDocs and Swagger UI supports.
You can find more info about MkDocs plugins and Swagger UI on the official website ofMkDocsandSwaggerUI.The input OpenAPI files processed by the plugin should conform to theOpenAPI specification. It is generated by a few projects such aspydantic,FastAPIand others.Disclaimer: This plugin is unofficial, and is not sponsored, owned or endorsed by mkdocs, swagger, or any other 3rd party.Credits to @aviramha for starting this project.
Package: mkdocs-resize-images
MkDocs Resize Images PluginThis MkDocs plugin finds all folders with a certain name, by defaultassets-large, resizes all images in those folders according to the plugin configuration.
Then saves the resized images in a different folder, by defaultassets.
The plugin also supports caching: if a file has not changed since the last time the plugin ran, it won't be processed again.InstallationInstall the plugin using pip fromPyPI:pipinstallmkdocs-resize-imagesActivate the plugin inmkdocs.yml:plugins:-search-resize-imagesCreate.gitignorefile in your project root directory and add the following line to it:assets-large# or whatever you have set as source-dir.resize-hash# if you have enabled cachingUsageBy default, the plugin will look for images in all directories named assets-large, resize them to 800x600 pixels, and then save the resized images in assets directories in the same parent directories as the assets-large directories.You can configure the plugin in your mkdocs.yml:plugins:-search-resize-images:source-dir:assets-largetarget-dir:assetsenable_cache:Truesize:[800,600]extensions:['.jpg','.jpeg','.png','.gif','.svg']source-dir: The name of the directories to search for images to resize. Default isassets-large.target-dir: The name of the directories to save the resized images in. Default isassets.size: The size to resize the images to, specified as [width, height]. Default is[800, 600].extensions: List of image file extensions to consider for resizing. The plugin will look for images with these extensions in both lower and upper case. Default is['.jpg', '.jpeg', '.png', '.gif', '.svg'].enable_cache: Whether to enable caching. If enabled, the plugin will check if a file has changed since the last time the plugin ran, and if not, it won't process the file again. Default isTrue.
Package: mkdocs-ringcentral-api-index
mkdocs-ringcentral-api-indexA MkDocs plugin created by RingCentral to assist in the creation of an API Quick Reference based upon a swagger specification. The output of this plugin can be seen here:https://developers.ringcentral.com/guide/basics/api-indexAt RingCentral we had the desire to publish an API Quick Reference that would make it easier for developers to scan for the endpoint they are looking for and quickly access the documentation for that endpoint in our API Reference. To solve this problem, we created a plugin that will take as input an OAS 3.0 API specification, and output a markdown file that can rendered within mkdocs.The output file can be modified by editing a template file.This plugin may not work as expected out-of-the-box for any OAS specification, as it makes use of a number of proprietary OAS elements specific to RingCentral, including:x-availabilityx-user-permissionx-app-permissionx-throttling-groupSetupInstall the plugin using pip:pip install mkdocs-ringcentral-api-indexActivate the plugin inmkdocs.yml:plugins:-search-ringcentral-api-index:spec_url:'https://netstorage.ringcentral.com/dpw/api-reference/specs/rc-platform.yml'outfile:'docs/api-index.md'Note: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.Optionsspec_url: Sets the URL to the Swagger specification for the RingCentral platform. This should default to the official URL. Override this for development purposes only.outfile: The file to output. This file is typically somewhere in your docs folder.More information about plugins in theMkDocs documentation.How the plugin worksThis plugin works by generating a markdown file prior to the rest of a mkdocs project being built. In other words, as soon as mkdocs is started, this plugin downloads a spec file, parses it, generates a markdown file, and saves that file into the documentation tree. Then to make the generated page appear in your documentation, you add the file to yourpagestree. For example:plugins:-ringcentral-api-index:outfile:api/quick-reference.mdpages:-'Home':index.md-'QuickReference':api/quick-reference.mdSee AlsoMore information about templateshere.More information about blockshere.
Package: mkdocs-roamlinks-plugin-extra
MkDocs Roamlinks Plugin + ExtraThis is a fork of the originalmkdocs-roamlinks-plugin.An MkDocs plugin that simplifies relative linking between documents and convert [[roamlinks]] forvscode-foam&obsidianLinksPyPiForked RepositoryChangesThis plugin adds functionality to convert special characters like>to proper links.SetupInstall the plugin using pip:pip install mkdocs-roamlinks-plugin-extraUsageActivate the plugin inmkdocs.yml:plugins:-roamlinks_extra
Package: mkdocs-rss-plugin
MkDocs RSS pluginA plugin forMkDocs, the static site generator, which createsRSS 2.0andJSON Feed 1.1feeds using the creation and modification dates fromgit logand page metadata (YAML frontmatter).Installationpipinstallmkdocs-rss-pluginUsageMinimalmkdocs.ymlconfiguration:site_description:required. Used as feed mandatory channel description.site_name:required. Used as feed mandatory channel title and items source URL label.site_url:required. Used to build feed items URLs.Minimal plugin option:plugins:-rssFull options:plugins:-rss:abstract_chars_count:160# -1 for full contentabstract_delimiter:<!-- more -->categories:-tagscomments_path:"#__comments"date_from_meta:as_creation:"date"as_update:falsedatetime_format:"%Y-%m-%d%H:%M"default_timezone:Europe/Parisdefault_time:"09:30"enabled:truefeed_ttl:1440image:https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.pngjson_feed_enabled:truelength:20match_path:".*"pretty_print:falserss_feed_enabled:trueurl_parameters:utm_source:"documentation"utm_medium:"RSS"utm_campaign:"feed-syndication"use_git:trueuse_material_social_cards:trueFor further information,see the user documentation.Following initiative from the author of Material for MkDocs, this plugin provides its own JSON schema to validate configuration:source-documentation.DevelopmentClone the repository:# install development dependenciespython-mpipinstall-U-rrequirements/development.txt# alternatively: pip install -e .[dev]# install project as editablepython-mpipinstall-e.# install git hookspre-commitinstallThen follow thecontribution guidelines.Run the tests# install development dependenciespython-mpipinstall-U-rrequirements/testing.txt# alternatively: pip install -e .[test]# run testspytestBuild the documentation# install dependencies for documentationpython-mpipinstall-U-rrequirements/documentation.txt# alternatively: pip install -e .[doc]# build the documentationmkdocsbuildRelease workflowFill theCHANGELOG.mdChange the version number in__about__.pyApply a git tag with the relevant version:git tag -a 0.3.0 {git commit hash} -m "New awesome feature"Push tag to main branch:git push origin 0.3.0