Skip to content

Commit

Permalink
docs: Rename remaining "author-mode" to "serve"
Browse files Browse the repository at this point in the history
Signed-off-by: Jorge Marques <[email protected]>
  • Loading branch information
gastmaier committed Jan 9, 2025
1 parent 484dfdd commit fb0ebb6
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The generated documentation will be available at `docs/_build/html` and it
provides information about the `adoc` command line tool and general documentation
guidelines.

In summary, the `author-mode` allows to live reload the documentation when editing
In summary, the `serve` allows to live reload the documentation when editing
the docs, and `aggregate` to generate an aggregated documentation of the multiple
repositories.

Expand Down
4 changes: 2 additions & 2 deletions docs/ci.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@ To serve the build in a local server, Python built-in server can be used:

$python -m http.server -d /path/to/docs/_build/html

Or with hot reload using :ref:`author-mode`:
Or with hot reload using :ref:`serve`:

.. shell::

$adoc author-mode -d /path/to/docs
$adoc serve -d /path/to/docs

.. _ci-rolling-release:

Expand Down
6 changes: 3 additions & 3 deletions docs/docs_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,12 +177,12 @@ required for the PDF build.
the HTML pages of documentation. If not set, some components of the pages
may not render properly.

Alternatively, WeasyPrint can be used with :ref:`author-mode` with this command:
Alternatively, WeasyPrint can be used with :ref:`serve` with this command:

.. shell::

~/some_repository/docs
$adoc author-mode --directory . --builder pdf
$adoc serve --directory . --builder pdf

The advantage of WeasyPrint is that the design styles (CSS stylesheet) is
respected.
Expand All @@ -197,7 +197,7 @@ For example, to render content during build that would instead be rendered with
third-party JavaScript libraries in the user browser.

Still, another approach is to patch the generated html, like is done at
:git-doctools:`adi_doctools/cli/aux_print.py` for :ref:`author-mode` and
:git-doctools:`adi_doctools/cli/aux_print.py` for :ref:`serve` and
:ref:`custom-doc` with pdf builders.

.. _local_refs:
Expand Down
2 changes: 1 addition & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ At the repository root, install the `npm` dependencies locally:

If you choose to not use ``npm``, you can obtain pre-built web-scripts from the
latest release.
For that, just run :ref:`author-mode` after the repository is installed and
For that, just run :ref:`serve` after the repository is installed and
confirm the prompt that will appear.

Fetch third-party resources
Expand Down

0 comments on commit fb0ebb6

Please sign in to comment.