Skip to content

Commit fdb14b1

Browse files
committed
Add sphinx-examples
1 parent 8d4e45c commit fdb14b1

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

docs/_toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ chapters:
77
- file: markdown
88
- file: notebooks
99
- file: markdown-notebooks
10-
- file: sphinx-hoverxref
1110
- file: intersphinx
11+
- file: sphinx-hoverxref
12+
- file: sphinx-examples

docs/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
# Jupyter Book on Read the Docs
44

55
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.
77

88
If you are using Read the Docs for the first time, have a look at the official [Read the Docs Tutorial][tutorial].
99
If you are using Jupyter Book for the first time, have a look at the [official Jupyter Book documentation][jb-docs].
1010

1111
## Why run Jupyter Book with Read the Docs?
1212

1313
[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.
1515

1616
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.
1717
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
3131
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:
3232

3333
* [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)
3535
* [sphinx-hoverxref to preview cross-references](/sphinx-hoverxref)
3636
* [sphinx-proof for logic and math, to write proofs, theorems, lemmas etc.](/sphinx-hoverxref) (TODO)
3737
* [sphinx-inline-tabs to display alternatives side-by-side with a tabbed interface](/sphinx-hoverxref) (TODO)

docs/sphinx-examples.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Examples boxes with sphinx-examples
2+
3+
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
8+
```{example} Example title
9+
Here's my **example**!
10+
```
11+

0 commit comments

Comments
 (0)