semvec/pypi-packages huggingface dataset:
mkdocs-pagelist-plugin 0.2.2
A MkDocs plugin to list pages based on tags and folders
License: MIT
Keywords: mkdocs python markdown pagelist

# PageListPlugin for MkDocs

PageListPlugin is a plugin for MkDocs that dynamically generates lists of pages based on tags, folders, and other criteria directly within your markdown files. It's especially useful for creating dynamic references to other parts of your documentation based on shared tags or directory structure. It may need tweaking for your needs.  The use of grouping by folders is helpful if you use the DiÃ¡taxis framework to organise your documents.  I have all my documents listed under the folders - Tutorials, How-to, Reference, 
Explanation. Tags are used to cross connect across those folders with features, functions or intended audience. 


## Installation

To install the plugin, use the following command:

```bash
pip install mkdocs-pagelist-plugin
```

For Github Actions add the following line in the appropriate place in the `ci.yml` file:

```yaml
- run: pip install mkdocs-pagelist-plugin  
```


## Usage

To use the PageListPlugin, add it to your `mkdocs.yml` configuration file under the plugins section:

```yaml
plugins:
  - search
  - pagelist
```

> **Note**: If you have no `plugins` entry in your config file yet, you'll need to add it before adding PageListPlugin, as MkDocs enables only the `search` plugin by default.



## Examples


- **List other pages sharing the same tags as the current page**:
  ```
  {pagelist}
  ```

- **List 10 pages sharing the same tags as the current page**:
  ```
  {pagelist 10}
  ```

- **Group pages by folder, sharing the same tags as the current page**:
  ```
  {pagelist g}
  ```

- **List pages tagged with 'draft'**:
  ```
  {pagelist 5 draft}
  ```

- **Combine multiple tags ('draft' and 'leads')**:
  ```
  {pagelist 10 draft leads}
  ```

- **Include pages with 'leads' tag but exclude those with 'draft' tag**:
  ```
  {pagelist 10 -draft leads}
  ```

- **Group pages by folder, tagged with 'leads'**:
  ```
  {pagelist g leads}
  ```

- **Group pages by folder, tagged with 'leads' but not 'draft'**:
  ```
  {pagelist g leads -draft}
  ```

- **List pages tagged with 'leads' in the 'how-to' folder**:
  ```
  {pagelist 10 leads | how-to}
  ```

- **Generate a report of all `{pagelist}` commands used across the site**:
  ```
  {pagelist i}
  ```

## HTML and CSS

The rendered code looks something like this:

```html
<div class="pagelist">
	<h3 class="pagelistheading">{folder.capitalize()}</h3>
	<ul class="pagelistlist">
		<li><a href="../../{page.url}">{page.title}</a></li>
	</ul>
</div>
```

## License

This project is licensed under the MIT License.

---
vnpy-tushare 1.4.7.0
Tushare datafeed for VeighNa quant trading framework.
License: MIT
Keywords: quant, quantitative, investment, trading, algotrading

# VeighNa框架的TuShare数据服务接口

<p align="center">
  <img src ="https://vnpy.oss-cn-shanghai.aliyuncs.com/vnpy-logo.png"/>
</p>

<p align="center">
    <img src ="https://img.shields.io/badge/version-1.4.7.0-blueviolet.svg"/>
    <img src ="https://img.shields.io/badge/platform-windows|linux|macos-yellow.svg"/>
    <img src ="https://img.shields.io/badge/python-3.10|3.11|3.12-blue.svg"/>
    <img src ="https://img.shields.io/github/license/vnpy/vnpy.svg?color=orange"/>
</p>

## 说明

基于tushare模块的1.4.7版本开发，支持以下中国金融市场的K线数据：

* 期货：
  * CFFEX：中国金融期货交易所
  * SHFE：上海期货交易所
  * DCE：大连商品交易所
  * CZCE：郑州商品交易所
  * INE：上海国际能源交易中心
* 股票：
  * SSE：上海证券交易所
  * SZSE：深圳证券交易所
  * BSE：北京证券交易所

注意：需要使用相应的数据服务权限，可以通过[该页面](https://www.tushare.pro)注册使用。

## 数据使用事项

tushare数据源期货数据中，第一条夜盘k线数据是集合竞价数据，用户可以根据自己需求进行过滤或者合并。

## 安装

安装环境推荐基于3.9.0版本以上的【[**VeighNa Studio**](https://www.vnpy.com)】。

直接使用pip命令：

```
pip install vnpy_tushare
```


或者下载源代码后，解压后在cmd中运行：

```
pip install .
```


## 使用

在VeighNa中使用TuShare时，需要在全局配置中填写以下字段信息：

|名称|含义|必填|举例|
|---------|----|---|---|
|datafeed.name|名称|是|tushare|
|datafeed.username|用户名|否|token|
|datafeed.password|密码|是|c3a110417f08f26d2c221edc0c50d4a8a5001502eea89cf5|


# 单元测试

单元测试代码目录为`./tests/test_*.py`
```sh
# 指定文件执行单元测试
python -m unittest tests\test_your_file_name.py

# 全量执行
python -m unittest
```