文件名称：sphinx-js:将您的JS项目的Autodoc样式提取到Sphinx中
文件大小：82KB
文件格式：ZIP
更新时间：2024-05-19 12:42:16
Python
狮身人面像 为什么 当您编写JavaScript库时，如何向人们解释？ 如果这是您的用户熟悉的领域中的一个小项目，那么JSDoc的例程列表就足够了。 但是在较大的项目中，将散文散布在您的API文档中很有用，而无需复制和粘贴内容。 使用sphinx-js，您可以将行业领先的文档工具与JS项目一起使用。 它提供了一些指令，这些指令以Python为中心的指令，用于将JSDoc格式的文档提取到reStructuredText页面中。 而且，因为您可以继续在代码中使用JSDoc，所以您与其他JS工具（例如Google的Closure Compiler）保持兼容。 sphinx-js也可以与TypeScript一起使用，使用TypeDoc工具代替JSDoc并发出您期望的所有类型信息。 设置 安装JSDoc（如果正在编写TypeScript，则安装TypeDoc）。 该工具必须位于$PATH ，因此
【文件预览】：
sphinx-js-master
----.circleci()
--------config.yml(396B)
----.gitignore(324B)
----setup.cfg(64B)
----sphinx_js()
--------parsers.py(2KB)
--------analyzer_utils.py(2KB)
--------jsdoc.py(15KB)
--------ir.py(9KB)
--------__init__.py(4KB)
--------suffix_tree.py(6KB)
--------directives.py(3KB)
--------typedoc.py(20KB)
--------templates()
--------renderers.py(14KB)
----README.rst(24KB)
----tests()
--------test_testing.py(354B)
--------test_build_js()
--------test_init.py(464B)
--------test_common_mark()
--------testing.py(5KB)
--------test_ir.py(527B)
--------test_jsdoc_analysis()
--------test_suffix_tree.py(2KB)
--------test_typedoc_analysis()
--------test_parsers.py(648B)
--------test_build_ts()
--------__init__.py(86B)
--------test_dot_dot_paths()
----LICENSE(1KB)
----CODE_OF_CONDUCT.md(495B)
----MANIFEST.in(60B)
----setup.py(1KB)
----.editorconfig(223B)
----tox.ini(859B)
----requirements_dev.txt(182B)