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: Update contributing doc #2895

Merged
merged 4 commits into from
Jun 6, 2024
Merged

fix: Update contributing doc #2895

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20972ee
fix: Update contributing doc
hpohekar Jun 3, 2024
157387b
rename _builds
hpohekar Jun 3, 2024
52f8346
Merge branch 'main' into fix/update_contributing_doc
hpohekar Jun 5, 2024
2e3007e
Merge branch 'main' into fix/update_contributing_doc
hpohekar Jun 5, 2024
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 doc/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ repository, run:

.. code::

pip install -r requirements/requirements_doc.txt
poetry install --with docs
cd doc
make html

After the build completes, the HTML documentation is located in the
``_builds/html`` directory. You can load the ``index.html`` file in
``_build/html`` directory. You can load the ``index.html`` file in
this directory into a web browser.

You can clear all HTML files from the ``_builds/html`` directory with:
You can clear all HTML files from the ``_build/html`` directory with:

.. code::

Expand Down
Loading