nikola icon indicating copy to clipboard operation
nikola copied to clipboard

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

Open htgoebel opened this issue 2 years ago • 4 comments

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.

htgoebel avatar Jul 08 '22 09:07 htgoebel

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

Kwpolska avatar Aug 01 '22 21:08 Kwpolska

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

htgoebel avatar Aug 02 '22 09:08 htgoebel

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.

blaisep avatar Aug 11 '22 15:08 blaisep

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

htgoebel avatar Aug 11 '22 16:08 htgoebel