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
Copy file name to clipboardExpand all lines: docs/intro.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,15 @@
3
3
# Jupyter Book on Read the Docs
4
4
5
5
This example shows a Jupyter Book project built and published on Read the Docs.
6
-
You're encouraged to use it to get inspiration and copy & paste from the files in [the source code repository][github]. In the source repository you will also find the relevant configuration and instructions for building Jupyter Book projects on Read the Docs.
6
+
You're encouraged to use it to get inspiration and copy & paste from the files in [the source code repository][github]. In the source repository, you will also find the relevant configuration and instructions for building Jupyter Book projects on Read the Docs.
7
7
8
8
If you are using Read the Docs for the first time, have a look at the official [Read the Docs Tutorial][tutorial].
9
9
If you are using Jupyter Book for the first time, have a look at the [official Jupyter Book documentation][jb-docs].
10
10
11
11
## Why run Jupyter Book with Read the Docs?
12
12
13
13
[Read the Docs](https://readthedocs.org/) simplifies developing Jupyter Book projects by automating building, versioning, and hosting of your project for you.
14
-
You might be familiar with Read the Docs for software documentation projects, but these features are just as relevant for science.
14
+
You might be familiar with Read the Docs for software documentation projects, but these features are just as relevant for science.
15
15
16
16
With Read the Docs, you can improve collaboration on your Jupyter Book project with Git (GitHub, GitLab, BitBucket etc.) and then connect the Git repository to Read the Docs.
17
17
Once Read the Docs and the git repository are connected, your project will be built and published automatically every time you commit and push changes with git.
@@ -31,7 +31,7 @@ It does not go in-depth into any particular topic - check out [the Jupyter Book
31
31
We have also added some popular features for Jupyter Book that really you shouldn't miss when building your own project with Jupyter Book and Read the Docs:
32
32
33
33
*[intersphinx to link to other documentation and Jupyter Book projects](/intersphinx)
34
-
*[sphinx-examples to show examples and results side-by-side](/sphinx-hoverxref) (TODO)
34
+
*[sphinx-examples to show examples and results side-by-side](/sphinx-examples)
35
35
*[sphinx-hoverxref to preview cross-references](/sphinx-hoverxref)
36
36
*[sphinx-proof for logic and math, to write proofs, theorems, lemmas etc.](/sphinx-hoverxref) (TODO)
37
37
*[sphinx-inline-tabs to display alternatives side-by-side with a tabbed interface](/sphinx-hoverxref) (TODO)
In this example project, we have enabled the extension `sphinx-examples` in `_config.yml` to be able to display source code alongside its rendered result.
4
+
5
+
You can use it this way:
6
+
7
+
```{example} Use examples to show source code and rendered result
0 commit comments