Skip to content

Fix Docs CI #9299

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 6, 2022
Merged

Fix Docs CI #9299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/dev/roadmap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/orgs/readthedocs/projects/156/views/1>`_
Expand All @@ -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
~~~~~~~~~~~~~~~
Expand Down
15 changes: 8 additions & 7 deletions docs/user/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <jupyterbook:publish/readthedocs>`,
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 <jupyterbook:sphinx:convert:pre-commit>`.
build:
jobs:
pre_build:
# Generate the Sphinx configuration for this Jupyter Book so it builds.
- "jupyter-book config sphinx docs/"