使用Jupyter Notebook编写技术文档】的更多相关文章

1.jupyter Notebook的组成 这里它的组件及其工程构成,帮助大家更好的用好jupyter Notebook 组件 Jupyter Notebook结合了三个组件: 笔记本Web应用程序:交互式Web应用程序,用于交互编写和运行代码以及编写笔记本文档. 内核:笔记本Web应用程序启动的独立进程,它以给定语言运行用户代码,并将输出返回给笔记本Web应用程序.内核还处理诸如交互式小部件,选项卡完成和内省的计算. 笔记本文档:自包含文档,其中包含笔记本Web应用程序中可见的所有内容的表示,…
编写技术文档,是令众多开发者望而生畏的任务之一.它本身是一件费时费力才能做好的工作.可是大多数时候,人们却总是想抄抄捷径,这样做的结果往往非常令人遗憾的,因为优质的技术文档是决定你的项目是否引人关注的重要因素.无论开源产品或面向开发者的产品,均是如此. 实际上,我想说明的是:对于面向开发者的产品来说,其用户体验中最重要的一环并不是什么主页设计.登录过程.或者SDK下载.真正最重要的是产品的API文档!如果没人知道你的产品如何使用,纵使它巧夺天工,又有何用? 如果你是一个专门从事面向开发者产品设计…
Kafka 技术文档   目录 1 Kafka创建背景 2 Kafka简介 3 Kafka好处 3.1 解耦 3.2 冗余 3.3 扩展性 3.4 灵活性 & 峰值处理能力 3.5 可恢复性 3.6 顺序保证 3.7 缓冲 3.8 异步通信 4 Kafka架构 4.1 producer 4.1.1 定义 4.1.2 负载均衡和HA(High Available)机制 4.1.3 Producer均衡算法 4.1.4 异步发送 4.2 Broker 4.3 Topic和Partition 4.3.…
RabbitMq 技术文档 目录 1 AMQP简介 2 AMQP的实现 3 RabbitMQ简介 3.1 概念说明 3.2 消息队列的使用过程 3.3 RabbitMQ的特性 4 RabbitMQ使用向导 5 官网提供的几种工作方式(教程) 5.1 Hello World 5.2 工作队列 5.3 发布/订阅 5.4 路由选择 (Routing) 5.5 主题(Topic) 5.6 RPC 6 消息的可靠传递 6.1 连接失败的处理 6.2 服务器的可靠性 6.3 生产者的可靠性 6.4 消费者…
unity3d 脚本参考-技术文档 核心提示:一.脚本概览这是一个关于Unity内部脚本如何工作的简单概览.Unity内部的脚本,是通过附加自定义脚本对象到游戏物体组成的.在脚本对象内部不同志的函数被特定的事件调用.最常用的列在下面:Update:这个函数在渲染一帧之前被调用,这里是大部分游戏行为代码被执行的地方,除了物理代码.FixedUpd 一. 脚本概览这是一个关于Unity内部脚本如何工作的简单概览.Unity内部的脚本,是通过附加自定义脚本对象到游戏物体组成的.在脚本对象内部不同志的函…
做项目一般都会要求写技术文档,特别是提供SDK或者基础组件的.如果手写这类技术文档的话,工作量比编写代码也少不了多少.比如 Java 语言本身就自带 javadoc 命令,可以从源码中抽取文档.本篇我们看一下OC中的一个类似工具:appledoc. 1.简介 基于命令行的操作.使用方便,默认生成的文档风格和苹果的官方文档是一致的,即docset,集成到xcode中就跟苹果的官方文档一模一样,在源码中按住option再单击就可以调出相应方法的帮助,当然也可以生成html文档. 总结一下,它具有下面…
showdoc 是一个很不错的api 以及技术文档管理工具 环境准备 doker-copose 文件 version: "3" services: doc: image: registry.docker-cn.com/star7th/showdoc volumes: - "./showdoc_data/html:/var/www/html/" ports: - "8080:80" 启动&&配置 启动 docker-compose…
前言 各种编程语言均有其优势和生态,有兴趣的朋友完全可以涉猎多门语言.在平常的工作之中,也可以尝试选择相对适合的编程语言来完成相关的工作. 在团队技术文档站搭建这块,笔者尝试了许多框架,最终还是选择了Hexo,主要是由于其丰富的主题和插件,并且灵活和高度可定制化,改起来也非常方便.我们团队文档站即使用Hexo来构建,并且基于容器配置了完整的代码流水线:docs.xin-lai.com 如果对站点配置.主题.插件存在疑问,可以加群沟通. 目录 官方镜像  编写一个简单的Web服务器  编码 编写D…
背景介绍 作为一个技术人员,基本都需要编写技术相关文档,而且大部分技术人员都应该掌握 markdown 这个技能,使用 markdown 来编写并生成 PDF 文档将会是一个不错的体验,以下就介绍下如何使用 VS Code + Markdown 来编写 PDF 文档 效果演示 环境准备 [必须]安装 Visual Studio Code [必须]安装 Extension - Markdown PDF,主要用于生成 PDF [可选]安装 Extension - markdownlint,用于 ma…
如果你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",加入这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的好处是什么? 答: 有文档的架构有助于不同利益相关者之间进行有效的沟通. 有文档的架构可以提供追溯其他工作产品的上下文. 有文档的架构可以传达可供选择的架构解决方案. 有文档的架构有助于从一个现有架构转换到一个新架构计划的计划编制. 有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划. 有文档的架构可以提醒架构师在其所作的某些决定背后的…