starlingx/docs
Code Issues Proposed changes

Add singlepage instructions (r8, r7. r6. r5)

Browse Source 
Add instructions for generating ouput as a single document to
the Contributor guide.
Add note about post-build checks.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I1b66f07e276a2227fb19747e3755a79ca6d5445b
This commit is contained in:
Ron Stone 2023-09-12 15:02:57 +00:00
parent 74480497b3
commit 4972909817
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/source/contributor/doc_contribute_guide.rst
View File

@ -52,6 +52,31 @@ Make a change
#. If needed, follow up with edits to your patch following the OpenStack
instructions for `Responding to requests <https://docs.openstack.org/doc-contrib-guide/quickstart/first-timers.html#responding-to-requests>`_.
.. build-singledoc-begin
It can sometimes be useful to search the output globally for a string that may
not be reliably returned by the built-in search functionality. For example, you
may need to find and update all instances of a version number or container name.
You can generate HTML output to a single page and use your browser's search
functionality to search globally.
To build all documentation as a single page, run the following command from
your local clone of the documentation repository:
.. code-block:: bash
$ tox -e singledoc
The output will be available in *<repo-root>*/``doc/build/singlepage``
.. note::
The quality checks done at the end of the build scan the most recent output
from running :command:`tox -e docs` and do not reflect any errors or
corrections in ``singledoc`` output.
.. build-singledoc-end
--------------------------
Find tasks and help needed