File tree 2 files changed +10
-9
lines changed 2 files changed +10
-9
lines changed Original file line number Diff line number Diff line change 4
4
Process
5
5
-------
6
6
7
- We publicly organize our product roadmap, on our `Roadmap `_ on GitHub project .
7
+ We publicly organize our product roadmap, on our `GitHub Roadmap `_.
8
8
Here, you will find several views into our roadmap:
9
9
10
10
`Current sprint <https://github.com/orgs/readthedocs/projects/156/views/1 >`_
@@ -18,7 +18,7 @@ Here, you will find several views into our roadmap:
18
18
The focus of the core team will be on roadmap and sprint items. These items are
19
19
promoted from our backlog before each sprint begins.
20
20
21
- .. _ Roadmap : https://github.com/orgs/readthedocs/projects/156/views/1
21
+ .. _ GitHub Roadmap : https://github.com/orgs/readthedocs/projects/156/views/1
22
22
23
23
Triaging issues
24
24
~~~~~~~~~~~~~~~
Original file line number Diff line number Diff line change @@ -353,12 +353,13 @@ As a result, you need to follow some extra steps
353
353
to make Jupyter Book work on Read the Docs.
354
354
355
355
As described in :doc: `the official documentation <jupyterbook:publish/readthedocs >`,
356
- you can manually convert your Jupyter Book project to Sphinx with the following command :
356
+ you can manually convert your Jupyter Book project to Sphinx with the following configuration :
357
357
358
- .. code-block :: console
358
+ .. code-block :: yaml
359
+ :caption : .readthedocs.yaml
359
360
360
- $ jupyter-book config sphinx path/to/book
361
-
362
- and then commit the resulting `` conf.py `` to git.
363
- Alternatively, you can set up some automation that does it for every change,
364
- for example :ref: ` using pre-commit < jupyterbook:sphinx:convert:pre-commit >`.
361
+ build :
362
+ jobs :
363
+ pre_build :
364
+ # Generate the Sphinx configuration for this Jupyter Book so it builds.
365
+ - " jupyter-book config sphinx docs/ "
You can’t perform that action at this time.
0 commit comments