Sphinx實用資源集合：Awesome Sphinx (Python文檔生成器)
Sphinx是一個工具，它能夠輕易地創建智慧和優雅的文檔，出自Georg Brandl之手，在BSD許可證下授權。它能夠把一組 reStructuredText 格式的文件轉換成各種輸出格式，而且自動地生成交叉引用，生成目錄等。也就是說，如果有一個目錄，里面包含一堆reST格式的文檔（可能子目錄里面也同樣存在reST格式的文檔），Sphinx能夠生成一個漂亮的組織結構以及便于瀏覽和導航的HTML 文件（這些文件在其他的文件夾中）。當然對于同樣的來源文件（reST格式），它也能夠生成一個能夠被編譯（生成）PDF版本的LaTeX格式的文件。
http://sphinx.pocoo.org/
http://readthedocs.org/ or http://rtfd.
以下是一些針對這個文檔生成器的實用資源：
目錄
Articles & Presentations
- Documenting Your Project With Sphinx
- Exercises for the Sphinx Tutorial that Brandon Rhodes often gives at PyCon.
Documentation
Extensions
- breathe
- ReStructuredText and Sphinx bridge to Doxygen.
- javasphinx
- Sphinx extension for documenting Java projects.
- numpydoc
- NumPy's Sphinx extensions.
- Releases
- A Sphinx changelog-generating extension.
- sphinx-autodoc-annotation
- Use Python 3 annotations in sphinx-enabled docstrings.
- sphinx-fortran-extension
- A Fortran domain and autodocumentation module for Sphinx.
- sphinx-git
- git Changelog for Sphinx.
- Sphinx-prompt
- Sphinx directive to add unselectable prompt.
- Sphinx-pyreverse
- Simple sphinx wrapper around pyreverse (from pylint suit) to generate UML diagramms from modules.
- sphinxcontrib-autojs
- The auto JavaScript documentation Sphinx extension.
- sphinxcontrib-autoprogram
- Provides an automated way to document CLI programs.
- sphinxcontrib-blockdiag
- Sphinx extension for embedding blockdiag diagrams.
- sphinxcontrib-cldomain
- Common Lisp domain for Sphinx.
- sphinxcontrib-docbookrestapi
- Sphinx extension that generates documentation for api-site from RST files.
- sphinxcontrib-fulltoc
- Extension for Sphinx to make the sidebar show a full table of contents instead of just the local headings.
- sphinxcontrib-httpdomain
- Provides a Sphinx domain for describing RESTful HTTP APIs.
- sphinxcontrib-programoutput
- Sphinx extension to include program output into documents.
- sphinxcontrib-napoleon
- Napoleon is a pre-processor that parses NumPy and Google style docstrings.
- Tut
- Tut is a tool that helps you write tutorial style documentation using Sphinx.
Internationalizations
- sphinx-intl
- Sphinx utility that make it easy to translate and to apply translation.
Miscellaneous
- ome-documentation
- Sphinx-based documentation for the Open Microscopy Environment.
- sphinx-gui
- Desktop GUI for editing Sphinx docs.
- sphinx-markdown-sample
- Markdown based sphinx the documentation generator sample.
Themes
- Alabaster
- Modified Kr Sphinx doc theme.
- flask-sphinx-themes
- Sphinx Themes for Flask related projects and Flask itself.
- krTheme Sphinx Style
- Sphinx theme Kenneth Reitz uses for most projects e.g. Requests.
- Sphinx Readable Theme
- A clean and readable Sphinx theme with focus on autodoc – documentation from docstrings.
- sphinx-better-theme
- A theme for Sphinx that looks nice, is easy to style with CSS, works well on small screens and mobile devices, and organizes the page better.
- sphinx_rtd_theme
- Sphinx theme for readthedocs.org.
- sphinx-theme-graphite
- A slightly muted light-on-dark theme for the Sphinx document generator using only CSS.
- sphinxjp.themes.basicstrap
- Sphinx theme built with responsive Bootstrap.
- sublee-sphinx-themes
- Sphinx themes Heungsub Lee uses for his projects e.g. Energy, Korean,Ranking, TrueSkill.
- sphinx-py3doc-enhanced-theme
- A theme based on the theme of https://docs.python.org/3/ with some responsive enhancements.
Publication
- Read the Docs
- Read the Docs hosts documentation, making it fully searchable and easy to find. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar. It supports webhooks so your docs get built when you commit code. There's also support for versioning so you can build docs from tags and branches of your code in your repository. A full list of features is available.
- Okydoky
- Automated docs builder using Sphinx/GitHub/Distribute for private use.
- sphinx-autobuild
- Watch a Sphinx directory and rebuild the documentation when a change is detected.
- sphinx-me
- Wraps your README-only projects in a dynamic Sphinx shell for hosting onRead the Docs.
- Sphinx to GitHub
- Script to prepare Sphinx html output for GitHub Pages.
- ghp-import
- Script to overwrite a gh-pages/master branch with a .nojekyll file for GitHub Pages.
本文由用戶 jopen 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。
轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。
本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！