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
Afterward, you can install the development dependencies:
175
-
176
-
.. code-block:: bash
177
-
178
-
pip install -r requirements.txt
179
-
180
174
Next, ``pre-commit`` needs to be configured so that the linting and code quality
181
175
checks are performed before each commit:
182
176
@@ -202,20 +196,20 @@ see the `NumPy development guide <https://numpy.org/doc/stable/dev/>`_.
202
196
Contributing to the documentation
203
197
---------------------------------
204
198
205
-
To contribute to the documentation, first follow the instructions in the previous section. Afterward, you can install the documentation dependencies in the virtual environment you created:
206
-
199
+
The documentation build dependencies have also been included in the virtual environment you created. You can also create a separate virtual environment just for the documentation using the `environment.yml` file located inside the `doc` folder.
207
200
208
201
.. code-block:: bash
209
202
210
-
pip install -r requirements-rtd.txt
203
+
conda env create -f doc/environment.yml
204
+
conda activate pytensor-docs
211
205
212
206
213
207
You can now build the documentation from the root of the project with:
214
208
215
209
216
210
.. code-block:: bash
217
211
218
-
python doc/scripts/docgen.py
212
+
python -m sphinx -b html ./doc ./html
219
213
220
214
221
215
Afterward, you can go to `html/index.html` and navigate the changes in a browser. One way to do this is to go to the `html` directory and run:
@@ -226,7 +220,7 @@ Afterward, you can go to `html/index.html` and navigate the changes in a browser
226
220
python -m http.server
227
221
228
222
**Do not commit the `html` directory. The documentation is built automatically.**
229
-
223
+
For more documentation customizations such as different formats e.g., PDF, refer to the `Sphinx documentation <https://www.sphinx-doc.org/en/master/usage/builders/index.html>`_.
0 commit comments