Skip to main content

Documentation toolchain for SecretFlow

Project description

@secretflow/doctools

License: MIT CI status

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

MIT © SecretFlow


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

许可证

MIT © SecretFlow

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

secretflow_doctools-0.4.0.tar.gz (34.4 kB view hashes)

Uploaded Source

Built Distributions

secretflow_doctools-0.4.0-py3-none-win_amd64.whl (47.8 kB view hashes)

Uploaded Python 3 Windows x86-64

secretflow_doctools-0.4.0-py3-none-manylinux_2_17_x86_64.whl (47.8 kB view hashes)

Uploaded Python 3 manylinux: glibc 2.17+ x86-64

secretflow_doctools-0.4.0-py3-none-macosx_10_9_x86_64.whl (47.8 kB view hashes)

Uploaded Python 3 macOS 10.9+ x86-64

secretflow_doctools-0.4.0-py3-none-any.whl (47.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page