Skip to content

Commit 020495c

Browse files
authored
Fix Docs CI (#9299)
Fix CI
1 parent 1af85af commit 020495c

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

docs/dev/roadmap.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Roadmap
44
Process
55
-------
66

7-
We publicly organize our product roadmap, on our `Roadmap`_ on GitHub project.
7+
We publicly organize our product roadmap, on our `GitHub Roadmap`_.
88
Here, you will find several views into our roadmap:
99

1010
`Current sprint <https://github.com/orgs/readthedocs/projects/156/views/1>`_
@@ -18,7 +18,7 @@ Here, you will find several views into our roadmap:
1818
The focus of the core team will be on roadmap and sprint items. These items are
1919
promoted from our backlog before each sprint begins.
2020

21-
.. _Roadmap: https://github.com/orgs/readthedocs/projects/156/views/1
21+
.. _GitHub Roadmap: https://github.com/orgs/readthedocs/projects/156/views/1
2222

2323
Triaging issues
2424
~~~~~~~~~~~~~~~

docs/user/faq.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -353,12 +353,13 @@ As a result, you need to follow some extra steps
353353
to make Jupyter Book work on Read the Docs.
354354

355355
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:
357357

358-
.. code-block:: console
358+
.. code-block:: yaml
359+
:caption: .readthedocs.yaml
359360
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/"

0 commit comments

Comments
 (0)