Skip to content

Commit

Permalink
Update dev guide
Browse files Browse the repository at this point in the history
  • Loading branch information
patnr committed Nov 1, 2024
1 parent 1ac0ad6 commit 24744ab
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ mkdocs serve
You should use relative page links, including the `.md` extension.
For example, `[link label](sibling-page.md)`.

This appears to work, but does not get validated! `[link label](../sibling-page)`
The following works, but does not get validated! `[link label](../sibling-page)`

!!! hint "Why not absolute links?"

Expand Down Expand Up @@ -135,9 +135,12 @@ Syntax: `[visible label][link]` i.e. double pairs of _brackets_. Shorthand: `[li
- Clearly, non-unique headings risk being confused with others in this way.
- The link (anchor) must be lowercase!

This facilitates linking to **API (code reference)** items.
For example, ``[`da_methods.ensemble`][]``,
where the backticks are optional (makes the link _look_ like a code reference).
This facilitates linking to

- **API (code reference)** items.
For example, ``[`da_methods.ensemble`][]``,
where the backticks are optional (makes the link _look_ like a code reference).
- **References**. For example ``[`bocquet2016`][]``,

### Docstring injection

Expand All @@ -147,6 +150,9 @@ Use the following syntax to inject the docstring of a code object.
::: da_methods.ensemble
```

But we generally don't do so manually.
Instead it's taken care of by the reference generation via `docs/gen_ref_pages.py`.

### Including other files

The `pymdown` extension ["snippets"](https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#snippets-notation)
Expand Down

0 comments on commit 24744ab

Please sign in to comment.