From 019c41426532e3cc688d64bb16fa45fb42b700f8 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Tue, 14 Nov 2023 17:14:55 +0200 Subject: [PATCH 1/2] Document 'make htmllive' --- documentation/devguide.rst | 12 +++++++++--- documentation/start-documenting.rst | 7 +++++-- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/documentation/devguide.rst b/documentation/devguide.rst index fb69988561..a6473e3dde 100644 --- a/documentation/devguide.rst +++ b/documentation/devguide.rst @@ -42,9 +42,15 @@ in the checkout directory. On Windows use: > .\make html -You will find the generated files in ``_build/html`` or, if you use -``make htmlview``, the docs will be opened in a browser once the build -completes. Note that ``make check`` runs automatically when you submit +You will find the generated files in ``_build/html``. + +.. tip:: * Substitute ``htmlview`` for ``html`` to open the docs in a web browser + once the build completes. + * Substitute ``htmllive`` (Unix only) for ``html`` to automatically + rebuild the docs, start a local server, and reload the page in your + browser after you save reST files. + +Note that ``make check`` runs automatically when you submit a :ref:`pull request `. You may wish to run ``make check`` and ``make linkcheck`` to make sure that it runs without errors. diff --git a/documentation/start-documenting.rst b/documentation/start-documenting.rst index ea72704f17..3c67342204 100644 --- a/documentation/start-documenting.rst +++ b/documentation/start-documenting.rst @@ -122,8 +122,11 @@ To build the docs as HTML, run:: make html -.. tip:: Substitute ``htmlview`` for ``html`` to open the docs in a web browser - once the build completes. +.. tip:: * Substitute ``htmlview`` for ``html`` to open the docs in a web browser + once the build completes. + * Substitute ``htmllive`` (Unix only) for ``html`` to automatically + rebuild the docs, start a local server, and reload the page in your + browser after you save reST files. To check the docs for common errors with `Sphinx Lint`_ (which is run on all :ref:`pull requests `), use:: From 058fce5522c766e53b59e0d53db2fc7483a65244 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Wed, 15 Nov 2023 14:33:56 +0200 Subject: [PATCH 2/2] Reword --- documentation/devguide.rst | 8 ++++---- documentation/start-documenting.rst | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/documentation/devguide.rst b/documentation/devguide.rst index a6473e3dde..b8d1de28d3 100644 --- a/documentation/devguide.rst +++ b/documentation/devguide.rst @@ -44,11 +44,11 @@ in the checkout directory. On Windows use: You will find the generated files in ``_build/html``. -.. tip:: * Substitute ``htmlview`` for ``html`` to open the docs in a web browser +.. tip:: * Replace ``html`` with ``htmlview`` to open the docs in a web browser once the build completes. - * Substitute ``htmllive`` (Unix only) for ``html`` to automatically - rebuild the docs, start a local server, and reload the page in your - browser after you save reST files. + * Replace ``html`` with ``htmllive`` to rebuild the docs, + start a local server, and automatically reload the page in your + browser when you make changes to reST files (Unix only). Note that ``make check`` runs automatically when you submit a :ref:`pull request `. You may wish to run ``make check`` diff --git a/documentation/start-documenting.rst b/documentation/start-documenting.rst index 3c67342204..817f0a1cff 100644 --- a/documentation/start-documenting.rst +++ b/documentation/start-documenting.rst @@ -122,11 +122,11 @@ To build the docs as HTML, run:: make html -.. tip:: * Substitute ``htmlview`` for ``html`` to open the docs in a web browser +.. tip:: * Replace ``html`` with ``htmlview`` to open the docs in a web browser once the build completes. - * Substitute ``htmllive`` (Unix only) for ``html`` to automatically - rebuild the docs, start a local server, and reload the page in your - browser after you save reST files. + * Replace ``html`` with ``htmllive`` to rebuild the docs, + start a local server, and automatically reload the page in your + browser when you make changes to reST files (Unix only). To check the docs for common errors with `Sphinx Lint`_ (which is run on all :ref:`pull requests `), use::