安裝中文字典英文字典辭典工具!
安裝中文字典英文字典辭典工具!
|
- Sphinx — Sphinx documentation
These sections cover various topics in using and extending Sphinx for various use-cases They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx If you are new to Sphinx, we recommend starting with Get started
- Getting started — Sphinx documentation
Much of Sphinx’s power comes from the richness of its default plain-text markup format, reStructuredText, along with its significant extensibility capabilities The goal of this document is to give you a quick taste of what Sphinx is and how you might use it
- Installing Sphinx — Sphinx documentation
Installing Sphinx¶ Sphinx is a Python application It can be installed in one of the ways described below Installation methods PyPI package Conda package OS-specific package manager Linux macOS Windows Docker Installation of the latest development release Installation from source After installation, you can check that Sphinx is
- Sphinx documentation contents
sphinx ext autosectionlabel – Allow referencing sections by their title; sphinx ext autosummary – Generate autodoc summaries; sphinx ext coverage – Collect doc coverage stats; sphinx ext doctest – Test snippets in the documentation; sphinx ext duration – Measure durations of Sphinx processing; sphinx ext extlinks – Markup to shorten
- Automatic documentation generation from code - Sphinx doc
While using sphinx ext autodoc makes keeping the code and the documentation in sync much easier, it still requires you to write an auto* directive for every object you want to document Sphinx provides yet another level of automation: the autosummary extension
- Extensions — Sphinx documentation
The awesome-sphinxdoc and sphinx-extensions projects are both curated lists of Sphinx packages, and many packages use the Framework :: Sphinx :: Extension and Framework :: Sphinx :: Theme trove classifiers for Sphinx extensions and themes, respectively
- Changelog — Sphinx documentation
Changelog¶ Release 8 3 0 (in development)¶ Dependencies¶ Incompatible changes¶ #13639: SphinxComponentRegistry create_source_parser() no longer has an app parameter, instead taking config and env Patch by Adam Turner Deprecated¶ 13627: Deprecate remaining public app attributes, including builder app, env app, events app, and SphinxTransform `app Patch by Adam Turner
- Build your first project — Sphinx documentation
In this tutorial you will build a simple documentation project using Sphinx, and view it in your browser as HTML The project will include narrative, handwritten documentation, as well as autogenerated API documentation
|
|
|