没有合适的资源?快使用搜索试试~ 我知道了~
sphinx-js:将您的JS项目的Autodoc样式提取到Sphinx中
共95个文件
rst:46个
py:27个
js:6个
需积分: 15 0 下载量 26 浏览量
2021-04-29
18:55:36
上传
评论
收藏 82KB ZIP 举报
温馨提示
狮身人面像 为什么 当您编写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.zip (95个子文件)
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
common.rst 651B
function.rst 447B
class.rst 1KB
attribute.rst 414B
renderers.py 14KB
README.rst 24KB
tests
test_testing.py 354B
test_build_js
source
more_code.js 169B
code.js 4KB
docs
autoattribute_example.rst 39B
autoattribute_see.rst 35B
autoclass_exclude_members.rst 85B
unwrapped.rst 38B
autoattribute_deprecated.rst 96B
injection.rst 31B
autoclass_private_members.rst 68B
avoid_shadowing.rst 38B
autoclass_deprecated.rst 80B
autoclass_members_list_star.rst 66B
conf.py 199B
autofunction_typedef.rst 36B
autofunction_see.rst 33B
autofunction_deprecated.rst 92B
index.rst 0B
autofunction_short.rst 64B
autofunction_defaults_doclet.rst 48B
autofunction_destructured_params.rst 40B
autoclass_members_list.rst 63B
autofunction_example.rst 32B
getter_setter.rst 42B
autofunction_explicit.rst 123B
autoclass_no_paramnames.rst 115B
autoclass_example.rst 31B
autofunction_long.rst 48B
autoclass_alphabetical.rst 47B
autoattribute.rst 46B
autoclass_see.rst 27B
autoclass.rst 34B
autofunction_defaults_code.rst 46B
union.rst 27B
autofunction_callback.rst 37B
autofunction_variadic.rst 39B
autofunction_minimal.rst 33B
autoclass_members.rst 47B
test_build_js.py 14KB
test_init.py 464B
test_common_mark
source
code.js 35B
docs
conf.py 595B
index.md 41B
test_common_mark.py 353B
testing.py 5KB
test_ir.py 527B
test_jsdoc_analysis
source
class.js 628B
function.js 463B
test_jsdoc.py 5KB
test_suffix_tree.py 2KB
test_typedoc_analysis
source
types.ts 2KB
tsconfig.json 121B
nodes.ts 819B
pathSegments.ts 844B
test_typedoc_analysis.py 16KB
test_parsers.py 648B
test_build_ts
test_build_ts.py 4KB
source
tsconfig.json 121B
docs
autoclass_star.rst 57B
conf.py 266B
autoclass_interface_optionals.rst 46B
autoclass_class_with_interface_and_supers.rst 58B
index.rst 271B
autoclass_exported.rst 32B
autoclass_constructorless.rst 39B
class.ts 898B
__init__.py 86B
test_dot_dot_paths
test_dot_dot_paths.py 456B
source
code.js 47B
docs
conf.py 233B
index.rst 25B
LICENSE 1KB
CODE_OF_CONDUCT.md 495B
MANIFEST.in 60B
setup.py 1KB
.editorconfig 223B
tox.ini 859B
requirements_dev.txt 182B
共 95 条
- 1
资源评论
徐校长
- 粉丝: 35
- 资源: 4615
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功