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.7.2.tar.gz (50.1 MB view details)

Uploaded Source

Built Distributions

secretflow_doctools-0.7.2-py3-none-win_amd64.whl (14.6 MB view details)

Uploaded Python 3 Windows x86-64

secretflow_doctools-0.7.2-py3-none-manylinux_2_17_x86_64.whl (17.6 MB view details)

Uploaded Python 3 manylinux: glibc 2.17+ x86-64

secretflow_doctools-0.7.2-py3-none-macosx_10_9_x86_64.whl (17.7 MB view details)

Uploaded Python 3 macOS 10.9+ x86-64

secretflow_doctools-0.7.2-py3-none-any.whl (50.3 MB view details)

Uploaded Python 3

File details

Details for the file secretflow_doctools-0.7.2.tar.gz.

File metadata

  • Download URL: secretflow_doctools-0.7.2.tar.gz
  • Upload date:
  • Size: 50.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for secretflow_doctools-0.7.2.tar.gz
Algorithm Hash digest
SHA256 1fb6303a25f9de9e7bf154e1a594cf9ff3cb7c3dcb4cf199bcc02b55019778a6
MD5 bcfbf621fbf2a1a88e9b7d8e1cc5a717
BLAKE2b-256 6dbf289b2f72063850e8085aadc017277eebe22da750615ab2e6c8ae3bc4887f

See more details on using hashes here.

File details

Details for the file secretflow_doctools-0.7.2-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for secretflow_doctools-0.7.2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 aec0efa1524655d4e5b08f1e7160449ae269749db3b44af1acf567ecf9573e30
MD5 c0b2463b304631dc8a78e4e39124558f
BLAKE2b-256 e9a9de971a5af3de80f12282419215fb720b4f6685c456c72d43619a357a24c4

See more details on using hashes here.

File details

Details for the file secretflow_doctools-0.7.2-py3-none-manylinux_2_17_x86_64.whl.

File metadata

File hashes

Hashes for secretflow_doctools-0.7.2-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 1820c6d29f4b4bf871938c05261fb052a8d42d062d87ae295c00e2002f3b7423
MD5 4d034fc835acf432cd234ac2b832a6ae
BLAKE2b-256 7611241b86272b771761fa6df3005bbc356155e7830658447dcb98f6ea7d9582

See more details on using hashes here.

File details

Details for the file secretflow_doctools-0.7.2-py3-none-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for secretflow_doctools-0.7.2-py3-none-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 7ece0cca6b45e8a13b1cd3e7b54343c8739f6c135d0e7d925e6ec71ecd6ac85b
MD5 9eb07c89a991c4ea4b18299e95904ad0
BLAKE2b-256 a7a38f60500ab90896ee9b10799caf85307088e6a135cd403134ea778d07c6b6

See more details on using hashes here.

File details

Details for the file secretflow_doctools-0.7.2-py3-none-any.whl.

File metadata

File hashes

Hashes for secretflow_doctools-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 879fd15c290e78e459014643b4431ecbeda3ac76fc1a77526c38d1790d36ba7e
MD5 e645f84f498249b48b2fe8afbd6d77e7
BLAKE2b-256 4b5229a368d4e26db4baddc6e226d645ed3850bff0d9b0a35f70c75db731e664

See more details on using hashes here.

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