Documentation toolchain for SecretFlow
Project description
@secretflow/doctools
Documentation toolchain for SecretFlow | SecretFlow 文档构建工具
English | 简体中文
What is this?
This repository contains packages for building documentation for SecretFlow projects. It provides a Sphinx extension to build MDX (Markdown + JSX) documents from a Sphinx project. It also has several Node packages for integrating MDX into Dumi.
Install
Install doctools with pip
:
pip install secretflow-doctools
Use
Add doctools as a Sphinx extension to your Sphinx project's conf.py
:
extensions = [
# ...
"secretflow_doctools",
]
Then specify mdx
as the builder:
python3 -m sphinx -b mdx [...] [sourcedir] [outputdir]
Or use make
:
make mdx
License
English | 简体中文
这是什么?
这个仓库包含了用于构建 SecretFlow 项目文档的工具。它提供了一个 Sphinx 扩展,用于从 Sphinx 项目构建 MDX(Markdown + JSX)文档。它还包含了一些 Node 包,用于将 MDX 集成到 Dumi 中。
安装
使用 pip
安装这个工具:
pip install secretflow-doctools
使用
将 doctools 作为 Sphinx 插件添加到你的 Sphinx 项目的 conf.py
中:
extensions = [
# ...
"secretflow_doctools",
]
然后将 mdx
指定为 builder:
python3 -m sphinx -b mdx [...] [sourcedir] [outputdir]
或者使用 make
:
make mdx
许可证
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for secretflow_doctools-0.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81ca4e35afc916cb29e6b3b872ad811b82e80b6bec469fa80290e0183b111460 |
|
MD5 | 626105723415c4d3e18e3a80a9505c86 |
|
BLAKE2b-256 | 31ec3a40c7b96c8a117ac413116cf6e22a2984fbb01c41aa540835d18e4bf5a9 |
Hashes for secretflow_doctools-0.6.0-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d13408a17d807010a8289692ee608a5cefd7259f81df804ce0f7392e92252623 |
|
MD5 | 529a3b6617765b676d802afc2c554d04 |
|
BLAKE2b-256 | 9774e2e7abd2316ee9d91139f608bc03b71daf688564a8cf9634c776fe6d4f29 |
Hashes for secretflow_doctools-0.6.0-py3-none-manylinux_2_17_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f65d26b9b6c0c9b7a9aebb3cc3acc95c4b60362c23112a64519341ddc8254ab |
|
MD5 | 6f541a5d4e47102f0dfea6576c840cfc |
|
BLAKE2b-256 | cc47f8c02790a58b88f00f5c34d3435aec5201726d24c2f5bd96e7601a137b03 |
Hashes for secretflow_doctools-0.6.0-py3-none-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7af1ab45f5c04803680fde1f7b9ee482c64741c4453c23a981bed7711e7a377 |
|
MD5 | 640862dcec7eda999915945a6031903b |
|
BLAKE2b-256 | 6b0cdef3842d3f13521f6a71a3d0e26533e0a6b6b9576558e8ce411a2d676e79 |
Hashes for secretflow_doctools-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a9ecba456bbf463425433081b8d469b5d869779af280969430b04550cc2cb32 |
|
MD5 | 4ac33d669c217579cf9271d6feef19f2 |
|
BLAKE2b-256 | ba64a43471fc50bdcee5925b1621f50969a3e11971b703112f71f718437f8064 |