diff --git a/docs/dev/roadmap.rst b/docs/dev/roadmap.rst index 9f1d13a4fe4..5fc7ad76a69 100644 --- a/docs/dev/roadmap.rst +++ b/docs/dev/roadmap.rst @@ -4,7 +4,7 @@ Roadmap Process ------- -We publicly organize our product roadmap, on our `Roadmap`_ on GitHub project. +We publicly organize our product roadmap, on our `GitHub Roadmap`_. Here, you will find several views into our roadmap: `Current sprint `_ @@ -18,7 +18,7 @@ Here, you will find several views into our roadmap: The focus of the core team will be on roadmap and sprint items. These items are promoted from our backlog before each sprint begins. -.. _Roadmap: https://github.com/orgs/readthedocs/projects/156/views/1 +.. _GitHub Roadmap: https://github.com/orgs/readthedocs/projects/156/views/1 Triaging issues ~~~~~~~~~~~~~~~ diff --git a/docs/user/faq.rst b/docs/user/faq.rst index b34b9e2702a..de58da78331 100644 --- a/docs/user/faq.rst +++ b/docs/user/faq.rst @@ -353,12 +353,13 @@ As a result, you need to follow some extra steps to make Jupyter Book work on Read the Docs. As described in :doc:`the official documentation `, -you can manually convert your Jupyter Book project to Sphinx with the following command: +you can manually convert your Jupyter Book project to Sphinx with the following configuration: -.. code-block:: console +.. code-block:: yaml + :caption: .readthedocs.yaml - $ jupyter-book config sphinx path/to/book - -and then commit the resulting ``conf.py`` to git. -Alternatively, you can set up some automation that does it for every change, -for example :ref:`using pre-commit `. + build: + jobs: + pre_build: + # Generate the Sphinx configuration for this Jupyter Book so it builds. + - "jupyter-book config sphinx docs/"