Skip to content

Commit 8d4e45c

Browse files
committed
Update intro text and links
1 parent 01163ad commit 8d4e45c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/intro.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
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 view it to get inspiration and copy & paste from the files in [the source code repository][github], where you will also find the relevant configuration 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+
78
If you are using Read the Docs for the first time, have a look at the official [Read the Docs Tutorial][tutorial].
89
If you are using Jupyter Book for the first time, have a look at the [official Jupyter Book documentation][jb-docs].
910

@@ -18,28 +19,27 @@ Furthermore, if you open Pull Requests, you can preview the result as rendered b
1819

1920
## What is in this example?
2021

21-
Jupyter Book has a number of built-in features, which you can see examples of here:
22+
Jupyter Book has a number of built-in features.
23+
This is a small example book to give you a feel for how book content is structured.
24+
It shows off a few of the major file types, as well as some sample content.
25+
It does not go in-depth into any particular topic - check out [the Jupyter Book documentation][jb-docs] for more information.
2226

2327
* [Examples of Markdown](/markdown)
2428
* [Rendering a notebook Jupyter Notebook](/notebooks)
2529
* [A notebook written in MyST Markdown](/markdown-notebooks)
2630

27-
We have also added some popular features for Jupyter Book that really you shouldn't miss when building your own project:
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:
2832

29-
* [intersphinx to link to other documentation and Jupyter Book projects](/sphinx-hoverxref)
30-
* [sphinx-examples to show examples and results side-by-side](/sphinx-hoverxref)
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)
3135
* [sphinx-hoverxref to preview cross-references](/sphinx-hoverxref)
32-
* [sphinx-proof for logic and math, to write proofs, theorems, lemmas etc.](/sphinx-hoverxref)
33-
* [sphinx-inline-tabs to display alternatives side-by-side with a tabbed interface](/sphinx-hoverxref)
36+
* [sphinx-proof for logic and math, to write proofs, theorems, lemmas etc.](/sphinx-hoverxref) (TODO)
37+
* [sphinx-inline-tabs to display alternatives side-by-side with a tabbed interface](/sphinx-hoverxref) (TODO)
3438

35-
## Jupyter Book examples
3639

37-
This is a small sample book to give you a feel for how book content is
38-
structured.
39-
It shows off a few of the major file types, as well as some sample content.
40-
It does not go in-depth into any particular topic - check out [the Jupyter Book documentation][jb-docs] for more information.
40+
## Table of Contents
4141

42-
Check out the content pages bundled with this sample book to see more.
42+
Here is an automatically generated Tabel of Contents:
4343

4444
```{tableofcontents}
4545
```

0 commit comments

Comments
 (0)