Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation build instructions #9350

Merged
merged 1 commit into from
Mar 11, 2024
Merged

Fix documentation build instructions #9350

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/en/guides/docs_contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ We also recommend you install to grammar check extension to help you to review E
Building
********

To build the documentation and generate the HTLM files, you can use the following command inside the ``docs`` folder. After a successful build, you can check the files inside the `build/html` folder.
To build the documentation and generate the HTML files, you can use the following command inside the ``docs`` folder. After a successful build, you can check the files inside the `_build/en/generic/html` folder.

.. code-block::

make html
build-docs -l en

This step is essential to ensure that there are no syntax errors and also to see the final result.

Expand Down Expand Up @@ -104,7 +104,7 @@ If everything is ok, you will see some output logs similar to this one:
dumping object inventory... done
build succeeded.

The HTML pages are in build/html.
The HTML pages are in `_build/en/generic/html`.

Sections
--------
Expand Down