Skip to content

Commit

Permalink
docs: Document init
Browse files Browse the repository at this point in the history
  • Loading branch information
SilverRainZ committed Jul 2, 2024
1 parent ddbb9fa commit 187db01
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,11 @@ Change Log
:date: yyyy-mm-dd
Change log here.
1.0a0
=====

.. version:: _
:date: 2024-07-03

The first alpha version is out, enjoy~
24 changes: 24 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ Introduction

.. ADDITIONAL CONTENT START
A Sphinx builder specialized for **fast incremental HTML** build.

The builtin HTML builder (``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 domain index, deal with config changed, and
so on. The fasthtml builder wraps the builtin one and **skips almost all
operations that slow down the build** and left only the necessary parts.

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

.. ADDITIONAL CONTENT END
Getting Started
Expand Down Expand Up @@ -39,6 +50,19 @@ Then, add the extension name to ``extensions`` configuration item in your conf.p

.. ADDITIONAL CONTENT START
Then you can run the builder:

.. code-block:: console
$ sphinx-build -b fasthtml <sourcedir> <outputdir>
For users who build document through Makefile, it is recommended to modify the
catch-all target as following:

.. literalinclude:: Makefile
:language: make
:lines: 20-

.. ADDITIONAL CONTENT END
Contents
Expand Down

0 comments on commit 187db01

Please sign in to comment.