doc: Small additions linking templates/themes to demo site.

getnikola / nikola

A static website and blog generator

https://getnikola.com/

MIT License

2.62k stars 451 forks source link

doc: Small additions linking templates/themes to demo site. #3634

Open htgoebel opened 2 years ago

htgoebel commented 2 years ago

Pull Request Checklist

[x] I’ve read the guidelines for contributing.

since the change is trivial, I abstreined from creating an issue first.
[x] I updated AUTHORS.txt and CHANGES.txt (if the change is non-trivial) and documentation (if applicable).

not applicable
[x] I tested my changes.

Description

Adds a few lines of text pointing from the templates/themes section to the demo site section. I was missing such a link.

Kwpolska commented 2 years ago

The tests fail, probably due to invalid link targets. Can you look into this?

htgoebel commented 2 years ago

I pushed a new version fixing this issue (rebased on current master bracnh already).

Lessons learned:

`demo site <demo-site>`_ does not link to the internal target "demo-site" (href='#demo-site"), but to the file (href="demo-site")
internal targets can contain spaces: Both .. _`demo site`: and .. _demo site: (without backticks) are okay

blaisep commented 2 years ago

I pushed a new version fixing this issue (rebased on current master bracnh already).

Lessons learned:

`demo site <demo-site>`_ does not link to the internal target "demo-site" (href='#demo-site"), but to the file (href="demo-site")

internal targets can contain spaces: Both .. _`demo site`: and .. _demo site: (without backticks) are okay

IIRC, in rst, if you want to point to the link in the final output you will want to use the :doc: field.

htgoebel commented 2 years ago

:doc: role is an extension, AFAIK sphinx introduced it. And was the name says, it is for linking to (the top of) documents.