You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/project_info/contributing.rst
+2-5Lines changed: 2 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -268,8 +268,6 @@ For the documentation, please adhere to the following guidelines:
268
268
Documentation Setup
269
269
-------------------
270
270
271
-
The documentation is built using `Sphinx <https://www.sphinx-doc.org>`_.
272
-
273
271
To get started, make sure you have ``pixi`` installed:
274
272
See :ref:`pixi-getting_started`.
275
273
We use ``pixi`` to manage the docs environment and tasks to streamline
@@ -278,15 +276,14 @@ the developer experience.
278
276
.. code-block:: console
279
277
280
278
$ ➜ pixi task list --environment docs
281
-
282
279
Tasks that can run on this machine:
283
280
-----------------------------------
284
-
build-docs, docs
281
+
build-apidocs, build-docs, docs
285
282
283
+
- build-apidocs Build the API documentation in the apidocs/ directory
286
284
- build-docs Build the documentation in the docs/ directory
287
285
- docs Serve the documentation on http://localhost:8000 with live reload
288
286
289
-
290
287
**Test if the docs build**:
291
288
To only build the documentation, you can use the ``build-docs`` task.
0 commit comments