Crystal语言mkdocstrings文档生成器
项目描述
mkdocstrings-crystal
Crystal语言doc生成器，用于MkDocs，通过mkdocstrings
简介
mkdocstrings-crystal 允许您将API文档（由Crystal的源代码和注释生成）作为MkDocs网站上的任何页面的部分插入。
要安装它，运行（可能在一个虚拟环境中）
pip install mkdocstrings-crystal
继续到文档网站。
用法
使用MkDocs，将此基本配置添加/合并到您的 mkdocs.yml
site_name: My Project
theme:
name: material
plugins:
- search
- mkdocstrings:
default_handler: crystal
markdown_extensions:
- pymdownx.highlight
- deduplicate-toc
然后，在任何 docs/**/*.md 文件中，您可以在 ::: 后面单独提及一个Crystal标识符
::: MyClass
::: Other::Class#some_method
::: Foo::CONSTANT
-- 并且在输出中，这将替换为为其生成的API文档，就像Crystal自己的文档生成器所做的那样。
当然，这是作为正常MkDocs构建过程的一部分发生的。
mkdocs build # generate from docs/ into site/
mkdocs serve # live preview
继续到文档网站。
下载文件
下载适用于您平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分布
mkdocstrings_crystal-0.3.7.tar.gz (16.9 kB 查看哈希值)
构建分布
关闭
哈希值 for mkdocstrings_crystal-0.3.7-py3-none-any.whl
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 91f25700a1e13ee5157aa5875441d333830c392d5ace7ef1c2106d9e5b2883b6 |
|
| MD5 | d12b956aa9fcc1e73da02fe63a61804e |
|
| BLAKE2b-256 | 8063ae7f6d546d8e74fa4aee6d17d829cb8c600583c3ab5a1b0e1e3da5dda23a |