Skip to content

Commit f851400

Browse files
committed
docs: Update contributing guide to reflect changes in documentation build tasks
1 parent 437a16f commit f851400

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

docs/project_info/contributing.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,6 @@ For the documentation, please adhere to the following guidelines:
268268
Documentation Setup
269269
-------------------
270270

271-
The documentation is built using `Sphinx <https://www.sphinx-doc.org>`_.
272-
273271
To get started, make sure you have ``pixi`` installed:
274272
See :ref:`pixi-getting_started`.
275273
We use ``pixi`` to manage the docs environment and tasks to streamline
@@ -278,15 +276,14 @@ the developer experience.
278276
.. code-block:: console
279277
280278
$ ➜ pixi task list --environment docs
281-
282279
Tasks that can run on this machine:
283280
-----------------------------------
284-
build-docs, docs
281+
build-apidocs, build-docs, docs
285282
283+
- build-apidocs Build the API documentation in the apidocs/ directory
286284
- build-docs Build the documentation in the docs/ directory
287285
- docs Serve the documentation on http://localhost:8000 with live reload
288286
289-
290287
**Test if the docs build**:
291288
To only build the documentation, you can use the ``build-docs`` task.
292289

0 commit comments

Comments
 (0)