Skip to content

Commit cd044bb

Browse files
committed
docs review
1 parent b6520fe commit cd044bb

File tree

2 files changed

+7
-12
lines changed

2 files changed

+7
-12
lines changed

docs/source/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ for producing exercise and solution directives, for html and pdf outputs.
2020

2121
**Features**:
2222

23-
The **exercise** directive is
23+
The **exercise** directive is:
2424

2525
1. automatically numbered
2626
2. supports options such as `class`, `label`, `nonumber`, and `hidden`
27-
3. can easily be referenced through `ref` and `numref` roles
27+
3. can be referenced through `ref` and `numref` roles
2828

2929
The **solution** directive
3030

@@ -37,7 +37,7 @@ The **solution** directive
3737
To get started with `sphinx-exercise`, first install it through `pip`:
3838

3939
```bash
40-
pip install -e.
40+
pip install sphinx-exercise
4141
```
4242

4343
### Jupyter-Book Project
@@ -50,7 +50,7 @@ sphinx:
5050
- sphinx_exercise
5151
```
5252
53-
you may then use `jb build <project>` and the extension will be used by your `JupyterBook` project.
53+
you may then use `jb build <project>` and the extension will be used by your `Jupyter Book` project.
5454

5555
### Sphinx Project
5656

docs/source/syntax.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,16 +62,14 @@ You can refer to an exercise using the `{ref}` role like ```{ref}`my-exercise` `
6262

6363
Enumerable directives can also be referenced through the `numref` role like ```{numref}`my-exercise` ```, which will display the number of the exercise directive. Referencing the above directive will display {numref}`my-exercise`. Furthermore, `numref` can take in three additional placeholders: _%s_ and _{number}_ which get replaced by the exercise number and _name_ by the exercise title.[^note]
6464

65-
66-
67-
<!-- You can refer to an exercise using the `{ref}` role like: ```{ref}`my-exercise` ```, which will replace the reference with the exercise number like so: {ref}`my-exercise`. When an explicit text is provided, this caption will serve as the title of the reference. -->
68-
6965
[^note]: If the exercise directive does not have a title, an `invalid numfig format` warning will be displayed during build if the user tries to use the _{name}_ placeholder.
7066

7167

7268
## Solution Directive
7369

74-
A solution directive can be included using the `solution` pattern. It takes in the label of the directive it wants to link to as a required argument. Unlike the `exercise` directive, the solution directive is unenumerable. The following options are also supported:
70+
A solution directive can be included using the `solution` pattern. It takes in the label of the directive it wants to link to as a required argument. Unlike the `exercise` directive, the solution directive not enumerable as it inherits directly from the linked exercise.
71+
72+
The following options are also supported:
7573

7674
* `label` : text
7775

@@ -83,9 +81,6 @@ A solution directive can be included using the `solution` pattern. It takes in t
8381

8482
Removes the directive from the final output.
8583

86-
```{note}
87-
The title of the solution directive links directly to the referred directive.
88-
```
8984

9085
**Example**
9186

0 commit comments

Comments
 (0)