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.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a31299c6e74c3f75e9194dd5912d2b72672679139ccfa24b59cd8bb1669f1357 |
|
MD5 | e2f8ab908b492d5f6a5520de4a6371dd |
|
BLAKE2b-256 | 505f5170e7f38bd02789755268a99242b6231000e2cacdf0cdf9b26251096370 |
Hashes for secretflow_doctools-0.4.1-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04ff94e4228c1766fc90adfd3e0f5a94c1b0cb9bd46200b9f4dc36a9e722759b |
|
MD5 | aaf96aac5d1ca29d5087b98c51c9e447 |
|
BLAKE2b-256 | 055f00617e45bcbcda4011765faa349f2651764c2505d8c2032113f7ca89513f |
Hashes for secretflow_doctools-0.4.1-py3-none-manylinux_2_17_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 686092f531b2344a82829eb6bbfd253f6bc9101cb0eded531ec002704dda4051 |
|
MD5 | 575854ff3b152fe8be29453cebb25a97 |
|
BLAKE2b-256 | f94c7447c222c68a814592a887f3a1511f7cb6a94c6c933d287804403913e41a |
Hashes for secretflow_doctools-0.4.1-py3-none-macosx_10_9_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 43c2353f6356c9775757ce3d95f2bcabcd435fe16b6f2705d21540c9f2d30bd3 |
|
MD5 | d31c86ad57df99dbcb4bbc390afdc8ec |
|
BLAKE2b-256 | 9f4aafb1dd558c24dbc6c2fff0a780969bdb7805dc1a5f1ad97dac3f641c31a3 |
Hashes for secretflow_doctools-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 768355e44efb0a766860a59b04baa107a377b5e47a2fcdffc5125262d8ff339b |
|
MD5 | 3e6f29679681c106c99caedf9056656d |
|
BLAKE2b-256 | c24aa582a73b18c9a3c38f9a9e286304acbf9c6aaf6f5b7b771ebb080612e60d |