Skip to content

Commit

Permalink
docs: Update intro
Browse files Browse the repository at this point in the history
  • Loading branch information
SilverRainZ committed Oct 18, 2024
1 parent 013feb2 commit ddc49d3
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,23 @@ Introduction
A Sphinx builder specialized for **fast incremental HTML** build.

Sphinx's HTML builder does a lot of works to ensure document consistency
(such as updating glob toctree, updating index, etc.) The fasthtml builder
**skips almost all operations that slow down the build** and left only the
necessary parts.

The builtin :py:class:`~sphinx.builders.html.StandaloneHTMLBuilder` supports
incremental build too, but it have to do a lot of extra work to ensure document
consistency (such as updating glob toctree, updating index, etc.) The fasthtml
builder **skips almost all operations that slow down the build** and left only
the necessary parts.
If you only want the document you modified to be updated, without paying
attention to the consistency of other places, the fasthtml builder will be
helpful to you.

If you often need to edit and build Sphinx documents locally, and only want to
preview the parts you modified, the fasthtml builder will be helpful to you.
.. note::

This extension relies on the internal implementation of HTML builder
(:py:class:`~sphinx.builders.html.StandaloneHTMLBuilder`), it may not be
compatible with older or future Sphinx versions.

So **DO NOT report to Sphinx first if you suffered crash**, please report to
here :issue:`new` instead.

.. INTRODUCTION END
Expand Down

0 comments on commit ddc49d3

Please sign in to comment.