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.7.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7abf6994570e6cebba272529473d90a722aca23efc799048bf26023bf83c3d12 |
|
MD5 | c41fb3bdaf2c8720276933e38e5b1b03 |
|
BLAKE2b-256 | b8b1d031a953f29eccb0200d67d2b2e597ad07ab6c48f7186348f8a8feee4e46 |
Hashes for secretflow_doctools-0.7.1-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6776411d6e832b9bacd99a0a9a721bf105ede9bc938c47af83ba8d9c7b58df3 |
|
MD5 | 57ba781b5dd30d92d1a2f179adf7883c |
|
BLAKE2b-256 | 313a23a6f64aac6cb26a3a40a5d4e11903e032dfffb14a7a2d9e8b0bd657b42b |
Hashes for secretflow_doctools-0.7.1-py3-none-manylinux_2_17_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c4740f7e990f6dc11227f6856b65318ec52e43690d312836e76e4fcf4d12de2 |
|
MD5 | 3e07ab13fff7d0792cff99a86ab37eb8 |
|
BLAKE2b-256 | 4a09c55dae87d5e88b94963cc93f4c097edaa1bf21c8caea60a8362c42de4c71 |
Hashes for secretflow_doctools-0.7.1-py3-none-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41dbf09b0a8abb3f3f83d6c185fa97e8c077fef739de9b8342ac5ce3ed726d4b |
|
MD5 | 97f35ec61a1ca9c04bf3a5d0c598d02d |
|
BLAKE2b-256 | fb1b022bed5cf045c916f9f9c9e86c58fd02b760fcc0fd2bb1baf0e9e0d7e8de |
Hashes for secretflow_doctools-0.7.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c23866e72163852e1c85034b95eab7ff0ba764fe20ee5254424b4a2c63fb1cb4 |
|
MD5 | fb370079b80044872bc237386ebc17f3 |
|
BLAKE2b-256 | d648c01d65bddf9bdfa8e022dbd9455e79896784baea84f0227b24d7f77ff61f |