为什么80%的码农都做不了架构师?>>>   hot3.png

淘到的一个Makefile,备份一下。

# Makefile for Sphinx documentation
## You can set these variables from the command line.
SPHINXOPTS    =
SPHINXBUILD   = sphinx-build
PAPER         =
BUILDDIR      = build# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif# Internal variables.
PAPEROPT_a4     = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettexthelp:@echo "Please use \`make <target>' where <target> is one of"@echo "  html       to make standalone HTML files"@echo "  dirhtml    to make HTML files named index.html in directories"@echo "  singlehtml to make a single large HTML file"@echo "  pickle     to make pickle files"@echo "  json       to make JSON files"@echo "  htmlhelp   to make HTML files and a HTML help project"@echo "  qthelp     to make HTML files and a qthelp project"@echo "  devhelp    to make HTML files and a Devhelp project"@echo "  epub       to make an epub"@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"@echo "  latexpdf   to make LaTeX files and run them through pdflatex"@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"@echo "  text       to make text files"@echo "  man        to make manual pages"@echo "  texinfo    to make Texinfo files"@echo "  info       to make Texinfo files and run them through makeinfo"@echo "  gettext    to make PO message catalogs"@echo "  changes    to make an overview of all changed/added/deprecated items"@echo "  xml        to make Docutils-native XML files"@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"@echo "  linkcheck  to check all external links for integrity"@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"clean:rm -rf $(BUILDDIR)/*html:$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html@echo@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."dirhtml:$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml@echo@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."singlehtml:$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml@echo@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."pickle:$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle@echo@echo "Build finished; now you can process the pickle files."json:$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json@echo@echo "Build finished; now you can process the JSON files."htmlhelp:$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp@echo@echo "Build finished; now you can run HTML Help Workshop with the" \".hhp project file in $(BUILDDIR)/htmlhelp."qthelp:$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp@echo@echo "Build finished; now you can run "qcollectiongenerator" with the" \".qhcp project file in $(BUILDDIR)/qthelp, like this:"@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ceph-deploy.qhcp"@echo "To view the help file:"@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ceph-deploy.qhc"devhelp:$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp@echo@echo "Build finished."@echo "To view the help file:"@echo "# mkdir -p $$HOME/.local/share/devhelp/ceph-deploy"@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ceph-deploy"@echo "# devhelp"epub:$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub@echo@echo "Build finished. The epub file is in $(BUILDDIR)/epub."latex:$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex@echo@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."@echo "Run \`make' in that directory to run these through (pdf)latex" \"(use \`make latexpdf' here to do that automatically)."latexpdf:$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex@echo "Running LaTeX files through pdflatex..."$(MAKE) -C $(BUILDDIR)/latex all-pdf@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."latexpdfja:$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex@echo "Running LaTeX files through platex and dvipdfmx..."$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."text:$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text@echo@echo "Build finished. The text files are in $(BUILDDIR)/text."man:$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man@echo@echo "Build finished. The manual pages are in $(BUILDDIR)/man."texinfo:$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo@echo@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."@echo "Run \`make' in that directory to run these through makeinfo" \"(use \`make info' here to do that automatically)."info:$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo@echo "Running Texinfo files through makeinfo..."make -C $(BUILDDIR)/texinfo info@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."gettext:$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale@echo@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."changes:$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes@echo@echo "The overview file is in $(BUILDDIR)/changes."linkcheck:$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck@echo@echo "Link check complete; look for any errors in the above output " \"or in $(BUILDDIR)/linkcheck/output.txt."doctest:$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest@echo "Testing of doctests in the sources finished, look at the " \"results in $(BUILDDIR)/doctest/output.txt."xml:$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml@echo@echo "Build finished. The XML files are in $(BUILDDIR)/xml."pseudoxml:$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml@echo@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

转载于:https://my.oschina.net/itfanr/blog/395029

Makefile for Sphinx documentation相关推荐

  1. 使用 Sphinx 撰写技术文档并生成 PDF 总结

    这几天准备编排部分翻译的书籍和文档,找了好些工具,最终定格在 Sphinx 上,并基于 ReadTheDocs 提供的 SaaS 服务进行分发和分享.本篇博客是对整个过程的一次记录和总结. 项目代码: ...

  2. 使用sphinx为python注释生成docAPI文档

    sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发. 新版的Python3文档就是由sphinx生成 ...

  3. 使用sphinx快速为你python注释生成API文档

    sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的 ...

  4. sphinx 项目根目录_如何使用Sphinx工具记录Django项目

    sphinx 项目根目录 I recently visited a company where I had a nice talk with one of its employees. We talk ...

  5. Sphinx 初始化项目

    Welcome to the Sphinx 1.5.6 quickstart utility.Please enter values for the following settings (just ...

  6. python文档生成_python文档生成工具:pydoc、sphinx;django如何使用sphinx?

    文档生成工具: 自带的pydoc,比较差 建议使用sphinx 安装: pip install sphinx 安装主题: 由各种主题,我选择常用的sphinx_rtd_theme pip instal ...

  7. Sphinx+Read the Docs文档编辑器

    建议Python3.6 官方虽然说支持python2.x 但是在 Python2.x下是安装不成功的(多次尝试之后发现是不成功的) Sphinx 将标记语言转化为html页面. 标记语言默认支持:re ...

  8. Linux内核的文档管理工具:Sphinx

    Sphinx主页:https://www.sphinx-doc.org/en/master/index.html 使用Sphinx作为文档管理的主页: Linux内核:https://www.kern ...

  9. 使用sphinx快速为你python注释生成API(html)文档

    sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的 ...

最新文章

  1. 东北大米为何如此好吃丨混乱博物馆
  2. 解决无法将类型为“System.Web.UI.WebControls.HiddenField”的对象强制转换为类型的错误...
  3. [论文阅读] (06) 万字详解什么是生成对抗网络GAN?经典论文及案例普及
  4. java实现多级菜单(java递归)方法二
  5. UFLDL教程: Exercise: Implement deep networks for digit classification
  6. SQL Server 查询表备注信息的语句
  7. Ubuntu修改/删除主目录下的中文文件夹
  8. 有没有改期末考试成绩的软件_如果考试成绩没有正常分配怎么办?
  9. android 机顶盒 view 焦点,AndroidTV/机顶盒 ListView获取焦点与点击事件问题处理方案...
  10. 坐标北京,Paddle Lite​ 线下交流会,助力算法落地​
  11. 【顶】辞职也需要辞得帅,辞得大家都开心,多为将来考虑,辞职不要急,本是好事要办好...
  12. 六石管理学:好大喜功,头目们是否相信
  13. JAVA 入门教程 2
  14. Mac系统下使用cd命令无法进入目录
  15. 15+在线网页按钮生成器工具
  16. 有哪些常用的虚拟主机管理系统
  17. 游狼html鼠标,《速评13》65g极轻FPS鼠标游狼SK
  18. Python | Python保存高维数组array,Python用pandas将numpy保存csv文件,Python保存3维数组
  19. 雅西高速交警列16处危险路段 司机需小心行驶
  20. mysql 1044 42000_[故障解决]Mysql爆出ERROR 1044 (42000)的错误怎么办?

热门文章

  1. 简述linux常见的安全措施,六个常用的Linux安全基本措施
  2. linux自动重启保护,Linux在崩溃时自动重启应用程序 – 守护进程
  3. mysql虚拟列表_「前端进阶」高性能渲染十万条数据(虚拟列表)
  4. Ripro主题化C位系列 演示站可调用内页图 于视频资源、素材下载站O-子主题
  5. C#联通新版验证码识别的实现[转]
  6. 通过RSS订阅、邮件转发自动同步多个Blog
  7. jquery 特效专辑
  8. tomcat调优方案
  9. 【AI视野·今日Robot 机器人论文速览 第三期】Tue, 8 Jun 2021
  10. CSS3 选择器总结(表格版)