Saravanan666/pypi-org huggingface dataset:
Package: mkdocs-rtd
mkdocs-rtdA fork of mkdocs readthedocs theme to make it work better, especially with mkapi.Why just useextra_cssandextra_javascript?The javascript written intheme.jsshipped with the original theme has problems expanding the sidebar items and it's not easy to fix it only usingextra_javascript.Installationpipinstall-Umkdocs-rtdUsagetheme:name:rtdAll options are the same when using the original theme (readthedocs). See also:https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocsModificationsAdd social icons (only Github supported now) to the top right corner of the page.Adjust some stylesOpen external links in new tab by defaultDo not reset side nav items when url hash is#or emptyMake search box stickyAdd css support forpymdownx.blocks.tab(must usealternate_style: true)SetignoreUnescapedHTMLtotrueforhljsKeep current sidebar item always in view when scrolling
Package: mkdocs-run-shell-cmd-plugin
MkDocs Plugin :run-shell-cmdThis is anMkDocsplugin that runs a specified
command (or commands) during thebuildandserveprocess and injects the
command and output into the generated site in a fenced block.It's very useful for documenting command-line programs, expecially during
development where the command line may change frequently.See theWebsitefor examples and full documentation.IMPORTANTInstallationConfiguration and UsageLicenseTODOIMPORTANTThis plugin allows running arbitrary commands on your system. It doesNOTcheck the command for safety, and it doesNOTrun the command in
a sandbox. However, it does ask you if you want to run each command, and it
does allow you to disable all commands from running again for the duration
of the session. Also commands are not run using a shell, so your environment
variables are not available to the command. Commands are set in the markdown
file, so they are not run unless you build, serve or publish the site. If
you are using a CI/CD pipeline to generate your docs, you should be aware
that some standard commands may be missing or blocked, and the CI will
probably hang due to waiting for input. Generating the docs on a local
machine and then pushing them up to your hosting is probably a better idea.InstallationInstall the package with pip:pipinstallmkdocs-run-shell-cmd-pluginor, if you are usingPoetry:poetryaddmkdocs-run-shell-cmd-plugin--groupdevConfiguration and UsageSee theWebsitefor
full usage information.LicenseThis is released under the MIT License. See the bundled LICENSE file for more
details.TODOSeeTODO.mdfor a list of outstanding tasks or ideas.
Package: mkdocs-safe-text-plugin
Plugin for safe text editing withMKDocs.Table of ContentsHow does this plugin work?InstallationPlugin configurationLicenseHow does this plugin work?Markdown is a very flexible format, and raw HTML is allowed. But it is
unnecessary in multiple-person text editing.When raw HTML like<font>tag is used in MKDocs, it is rendered as
it is.If you use this plug-in with MKDocs, tags that are not allowed in the
allowlist are escaped.InstallationInstall it via PyPI usingpipcommand.$pipinstallmkdocs-safe-text-pluginAnd add it to yourmkdocs.ymlfile.plugins:-mkdocs_safe_textAn example of use can be checked byexample/basic-usage.Plugin configurationThis plugin works with the HTML tag element for Markdown defined bybleach-allowlistenabled. This implementation approach is recommended inthe
Python-Markdown release
notes.And user can change this setting.plugins:-mkdocs_safe_text:append_allowed_tags:-tag1-tag2remove_allowed_tags:-tag3-tag4allowed_attrs:tag5:-attribute1-attribute2An example of use can be checked byexample/customization-usage.LicenseBSD 2-Clause
LicenseCHANGELOG1.5.1Clarified support for Python 3.11(fix metadata)1.5.0Clarified support for Python 3.111.4.0Clarified support for Python 3.10Dropped support Python 3.61.3.1Requiresbleach-allowlistversion 1.0.3 or higher1.3.0Migrate using Python package frombleach-whitelisttobleach-allowlistClarified support for Python 3.9Dropped support Python 3.51.2.0Clarified support for Python 3.8Dropped support Python 2.71.1.2Dropped support Python 3.41.1.1Fix to work even after MKDocs 1.0Dropped support Python 3.31.1.0Embed distribution license in source codeRemove dependency on ‘pytest-pythonpath’1.0.0First stable release versionSupport Python 3.3 or later0.5.0Support reST format in PyPI Web UIAdd dependency on pypandoc0.4.0Update status to Beta versionAdd documentation about this pluginAdd a Makefile for tidy tasks0.3.0Update status to Alpha version0.2.0Implement plugin configurationAdd class files tomkdocssafetextAdd unittest files totests0.1.0First planning versionMake temporary directory structureAdd requirement specifiers
Package: mkdocs-same-dir
mkdocs-same-dirPluginforMkDocsto allow placingmkdocs.ymlin the same directory as documentationpipinstallmkdocs-same-dirUsageActivate the plugin inmkdocs.yml, along with actually changingdocs_dir(normally, MkDocsabsolutely wouldn'tlet you set it to.):site_name:foodocs_dir:.site_dir:../siteplugins:-search-same-dirand now you can move thismkdocs.ymlinto yourdocsdirectory, or move your docs alongsidemkdocs.yml.See example layoutImportant notesAnother necessary effect of this plugin is that filesdirectly at the rootof thedocsdir will no longer be picked up, unless they are Markdown files.And note that theimplementationof this plugin is a huge hack that monkeypatches MkDocs' internals. But I pledge to keep up with MkDocs updates and keep it working as long as that's still possible.
Package: mkdocs-schema-reader
mkdocs schema reader pluginThis is a plugin that scans the specified directories and files for JSON Schema files, converts them to markdown and builds them into your documentation.SetupInstall the plugin using pip:pip install mkdocs-schema-readerActivate the plugin inmkdocs.yml:plugins:-search-schema_readerThen, specify folders and files that you want to include inmkdocs.ymlrelative to it's location, like so:plugins:-search-schema_reader:include:-"../JSONSchema/"-"../example/directory/schema.json"Specified directories will be scanned for schema json files, so consider specifying individual files for expansive directories.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.More information about plugins in the [MkDocs documentation][mkdocs-plugins].UsageJust activate the plugin, specify directories and files in the manner shown above, and it will operate when normal mkdocs commands are used like `mkdocs serve'
Package: mkdocs-select-files
File filter plugin for mkdocsselect-filesis amkdocs pluginthat filters out
files (pages) using a parametrized regular expression.The main use case for this plugin is to prepare lectures or assignments
and only publishing them at a given date.Quick startInstall the module using pip:pip3 install mkdocs-select-filesIn your project, add a plugin configuration tomkdocs.yml:plugins:-select-files:select:'^s(\d+)'where:'lambdax:int(x)<=5'This would search for files namedsNN...and select only those whereNNis
less than or equal to5.In thewhereexpression, you can use the following declared variablesnow: represent the current time inISO formatsfc: The value of theSELECT_FILE_CONDITIONenvironment variable.The modulesosanddatetimeare imported, so you can use methods from them.Disabling the pluginYou can disable the plugin using an environment variable. For example, you could configure
your site this way:plugins:-select-files:select:'^s(\d+)'where:'lambdax:int(x)<=5'disabled_if_env:SELECT_FILES_DISABLEDand then, running mkdocs withSELECT_FILES_DISABLEDset to 1 would disable this plugin
and let all pages be processed:SELECT_FILES_DISABLED=1mkdocs...CreditsThank you toLucy Linderfor her great idea of using parametrized
regular expressions.Similar pluginsmkdocs-exclude: exclude arbitrary file paths and
patterns from the input
Package: mkdocs-semantic
mkdocs-semanticMinimalisticSemantic-UItheme forMkDocswith a focus on web content.ExampleInstallation & Usage# using local terminalpipinstallmkdocs-semantic# in your mkdocs.yml file
theme: semanticConfigurationTheme customizations optionsLogoThe default logo is the Python icon from Semantic-UI, however it can be overidden using an image or an icon.To use an image, specify the URL or relative path to the image:theme:logo:image:'images/logo.png'To use an icon, specify the name of aSemantic-UI icon:theme:logo:icon:'python'BreadcrumbsThe breadcrumbs are enabled by default, but can be disabled through the breadcrumb variable:theme:breadcrumb:falseSidebarThe sidebar is enabled by default, but can be disabled through the sidebar variable:theme:sidebar:falseSearchThe search functionality is enabled by default (adding a search icon to the navbar), but can be disabled through the search variable:theme:search:falseDependenciesSemantic-UI >= 2.4highlight.js >= 9.12.0jQuery >= 3.3.1SourceGithubProject Road Mapadd toc
Package: mkdocs-semiliterate
MkDocs semiliterate PluginThis plugin forMkDocsis an extension of Allison Thackston's excellentmkdocs-simple-plugin. It allows you to include content from one file into another (via{! ... !}syntax), using exactly the same extraction specification that thesimpleplugin already uses for identifying documentation in source files.RationaleTime and trends have not validated Knuth's original vision of "literate programming" as a mainstream practice. Nevertheless, there remain significant advantages to incorporating all documentation, including user-guide-style narrative, into the source code for a project. These advantages include ease of maintenance and synchronization of code and documentation, and opportunities to make the ensemble of your code and documentation more DRY. Thus, it's worth using a "semiliterate" programming style, in whichcode is arranged as dictated by best software engineering practicesdocumentation is co-located in the same files next to the implementing codeand tools are provided for extracting and assembling that documentation into readable form.*[DRY]: Don't Repeat Yourself -- a coding philosophy of creating a single authoritative location for each piece of information.Thesimpleplugin goes a long way toward creating a semiliterate programming environment. However, in creating narrative documentation, it's very useful to be able to quote or incorporate content --- whether that be documentation blocks or code examples or code that itself serves as documentation to avoid repeating information --- from one file into another. To satisfy that need, thissemiliterateplugin extends (i.e, literally inherits from) thesimpleplugin and adds a syntax for such inclusion.With a few other small ease-of-use tweaks (documented in theUsagesection),
this extended plugin aims to produce a lightweight but comprehensive semiliterate programming environment. Thedocumentation siteis, of course, produced by MkDocs using the semiliterate plugin.InstallationThe mkdocs-semiliterate package which provides thesemiliterateplugin for MkDocs is available via PyPI:python3 -m pip install mkdocs-semiliterateor of course if yourpipis already set up to use a Python 3.5 (or later) installation, justpip install mkdocs-semiliterateLicense and AcknowledgmentsThis software is licensed underApache 2.0.Icons8provided the icon.
Package: mkdocs-simple-blog
MkDocs Simple BlogTheme forMkDocsInstallInstallation MkDocsTo install MkDocs, run the following command from the command line:pipinstallmkdocsInstallation themeInstall the theme using PIP:pipinstallmkdocs-simple-blogActivating themeAfter the theme is installed, edit yourmkdocs.ymlfile and set the theme name tosimple-blog:theme:
    name: simple-blogCommit Style⚙️ FEATURE📝 PEP8📌 ISSUE🪲 BUG📘 DOCS📦 PyPI❤️️ TEST⬆️ CI/CD⚠️ SECURITYLicenseThis project is licensed under the terms of the MIT license.
Package: mkdocs-simple-hooks
mkdocs-simple-hooksDefine your own hooks for mkdocs, without having to create a new package.SetupInstall the plugin using pip:pipinstallmkdocs-simple-hooksNext, add a python module to either thedocs/directory or the root mkdocs directory. Then, add the plugin and hooks definition to yourmkdocs.yml:plugins:-search-mkdocs-simple-hooks:hooks:hook-name:"your.module:hook_function"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.More information about plugins in theMkDocs documentation.UsageYou can use this plugin to create simple hooks formkdocswithout having to create
a separate plugin package.Just define a function and register it as a hook in themkdocs.yml. The function shall
have the same API as the desired hook. To see available hooks and their API, see the
events chapter in themkdocs documentation.ExampleLet's say you want to copy theREADME.mdfile todocs/index.md. To do that, create
a new file, e.g.:docs/hooks.py, and put the following function there:importshutildefcopy_readme(*args,**kwargs):shutil.copy("README.md","docs/index.md")Now, register the hook in yourmkdocs.yml:plugins:-mkdocs-simple-hooks:hooks:on_pre_build:"docs.hooks:copy_readme"That's all - thecopy_readme()function will run every time, before building the documentation.Disabling the pluginYou can use theenabledoption to optionally disable this plugin. A possible use case is local development where you might want faster build times. It's recommended to use this option with an environment variable together with a default fallback (introduced inmkdocsv1.2.1, seedocs). Example:plugins:-mkdocs-simple-hooks:enabled:!ENV[ENABLE_MKDOCS_SIMPLE_HOOKS,True]hooks:on_pre_build:"docs.hooks:copy_readme"Which enables you to disable the plugin locally using:exportENABLE_MKDOCS_SIMPLE_HOOKS=falsemkdocsserve
Package: mkdocs-simple-plugin
mkdocs-simple-pluginThis plugin enables you to build a documentation site from markdown interspersed within your repository usingmkdocs.AboutYou may be wondering why you would want to generate a static site for your project without doing the typical "wiki" thing of consolidating all documentation within a singledocsfolder or using a singleREADMEfile.My repository is too big for a single documentation source.Sometimes it isn't feasible to consolidate all documentation within an upper leveldocsdirectory.  In general, if your codebase is too large to fit well within a singleincludedirectory, your codebase is also too large for documentation in a singledocsdirectory.Since it's typically easier to keep documentation up to date when it lives as close to the code as possible, it is better to create multiple sources for documentation.My repository is too simple for advanced documentation.If your codebase isvery verylarge, something like themonorepo pluginmight better fit your needs.For most other medium+ repositories that have grown over time, you probably have scattered documentation throughout your code.  By combining all of that documentation while keeping folder structure, you can better surface and collaborate with others. And, let's face it.  That documentation is probably all in markdown since Github renders it nicely.I want a pretty documentation site without the hassle.Finally, you may be interested in this plugin if you have a desire for easy-to-generate stylized documentation.  This plugin lets you take documentation you may already have -- either in markdown files or in your code -- and formats them into a searchable documentation website.  You can keep your documentation where it is (thank you very much).Seemkdocs-simple-pluginfor usage.ContributingSee thecontributing guideLicenseThis software is licensed underApache 2.0
Package: mkdocs-simple-tags-plugin
TagsSupport for tags in the yaml-metadata in the header of markdown files.Extracts this metadata and creates a "Tags" page which lists all tags
and all pages for each tag.Quick DemoInstall this plugin (it will also install mkdocs if required)pipinstallmkdocs-simple-tags-pluginCreate a new documentation folder:mkdocsnewdemoEdit the.mdfiles to add initial metadata. Currently, the metadata has to be
enclosed in---lines, and must include atitle:property
(otherwise the page will appear as "untitled" in the tags page). So, for example:cddemocddocs
cat>index.md
---
title:Welcome
tags:-testing-unimportant
---# Welcome to MkDocsForfulldocumentationvisit[mkdocs.org](https://mkdocs.org).

^DEditmkdocs.ymlto include this plugin:plugins:-simple-tags:Run the server:mkdocsserve--livereloadVisit the URL/tags(it should appear in the nav panel).
This is an auto-generated page which contains the tags as level 2 headers,
and under each tag, a listing of the pages which declare that tag in the
metadata section.How it worksOn each build (even with--livereload), all the.mdfiles composing the
site are scanned, their "triple-dash-delimted" yaml header is extracted and
parsed, and the list of tags is collected.After that, a new temporal file is created (by default inaux/tags.md, but
this is customizable) which contains the generated tags page, in markdown
format. This file is not in the documents folder to avoid retriggering a
build, but it is added to the list of files to be converted to HTML by mkdocs.CustomizationThe layout of the tags page is a markdown file with jinja2 embedded contents.
The package provides such a template by default, with the following content:---title: Tags---# Contents grouped by tag{% for tag, pages in tags %}## <span class="tag">{{tag}}</span>{%  for page in pages %}*[{{page.title}}]({{page.filename}})
{% endfor %}

{% endfor %}You can style theh2.tagelement via CSS, if you want.You can also provide your own markdown template, in case that you want a
different layout or metadata. Thepageobject contains all the metadata
in a mkdocs page, and in addition a.filenameattribute, which contains
the file name of the source of the page (relative to the docs folder),
which can be used to link to that page.The full customizable options for the plugin are:folder: Folder in which the auxiliar tags markdown file will be written
(auxby default, relative to the folder in whichmkdocsis invoked).
It can be set to an absolute path, such as/tmp/mysite/aux.
The required folders are created.template: path to the file which contains the markdown-jinja template
for the tags page. It isNoneby default, which means that the
package-provided template is used. It can be an absolute path,
or relative to the folder in whichmkdocsis run.css_name: this allows you to pick what name styles the tag that appears on
the top of the page that contains a tag. This way things won't be overloadedFor example, this can be put atmkdocs.yaml:plugins:-search-simple-tags:folder:/tmp/mysite/auxtemplate:docs/theme/tags.md.template
Package: mkdocs-site-urls
MkDocs Site URLs PluginA MkDocs plugin that adds support for site-relativesite:URLs.Example:URLsite_urlresulting URLsite:images/foo.pnghttps://example.com//images/foo.pngsite:images/foo.pnghttps://example.com/bar//bar/images/foo.pngPlease note: This plugin requires MkDocs 1.5 or higher.Getting StartedInstall the plugin from PyPIpipinstallmkdocs-site-urlsAdd thesite-urlsplugin to yourmkdocs.ymlplugins section:plugins:-site-urlsStart using site-relative URLs in your Markdown files by prefixing them withsite::[Link to another page](site:another-page/relative/to/the/site/root)

![Image](site:images/foo.png)ConfigurationBy default the plugin will replace URLs inhref,srcanddataattributes. You can configure the attributes to replace
by setting theattributesoption in yourmkdocs.yml, e.g.:plugins:-site-urls:attributes:-href-src-data-data-urlBe advised that in case of any customization on your part you need to include the default attributes as well if you want
to keep them, as the default list will not be included automatically anymore.How it worksThe plugin hooks into theon_page_contenteventand replaces all URLs in the configured attributes (by defaulthref,srcordata) in the rendered HTML with the corresponding site-relative URLs.LicenseThis project is licensed under the MIT license, see theLICENSEfile for details.
Package: mkdocs-snakemake-rule-plugin
MkDocs Snakemake RuleMkDocs Plugin used to extract rule information.InstallationTo use this plugin, install it with pip in the same environment as MkDocs:pip install mkdocs-snakemake-rule-pluginConfigThen add the following entry to the MkDocs config file:plugins:
  - snakemake-rule:
      rule_folders:
        - 'workflow/rules'
      schemas:
        - 'workflow/schemas/rules.schema.yaml'TagformatFormat of tags are:#SNAKEMAKE_RULE_SOURCE__filename__rulename#: for source code extraction#SNAKEMAKE_RULE_TABLE__filename__rulename#: for table generationTab parts:first section identifies if rule source or table should be createdfilename is where the rule is stored, can be without '.skm'rulename is the rule that will be extractUsageAdd tags to your target file and they will be replaced with rule source or tablesMkDocs Markdown example# Rule information
## Source 
#SNAKEMAKE_RULE_SOURCE__fastp__fastp_pe#

## Parameters
#SNAKEMAKE_RULE_TABLEE__fastp__fastp_pe#
Package: mkdocs-snippet-plugin
mkdocs-snippet-pluginAn mkdocs plugin that injects snippets from a file in a git repository.InstallationNote:This package requires MkDocs version 0.17 or higher.Install the package with pip:pipinstallmkdocs-snippet-pluginEnable the plugin in yourmkdocs.yml:plugins:-snippet:base_path:docsThebase_pathentry should point to the root of your documentation site, usually defaulted todocs.How to use itIf you have a markdown file in a remote Git repostory, and you want to extract a sections from it, add the following to your documentation markdown in mkdocs:{{ snippet('git@github.com:mprivat/mkdocs-snippet-plugin.git', 'README.md', '## Installation') }}It will download the file you specify from the Git URL, extract the section you ask for (including its subsections) and inject that into your mkdocs file at render time.If the remote file has references to images, those will also be downloaded and placed in a_genfolder in the mkdocs hierarchy. You will probably want to include**/gen_in your.gitignorefile so you don't put those into your git repository unless you want them there.